From 57b321e22843f9b88b9a278c58c3c5d919629908 Mon Sep 17 00:00:00 2001 From: Maria Paula Caldas Date: Fri, 17 Apr 2020 21:00:50 +0200 Subject: [PATCH 1/2] First draft for CONTRIBUTING.md --- CONTRIBUTING.md | 43 +++++++++++++++++++++++++++++++++++++++++++ README.md | 2 ++ 2 files changed, 45 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..73194ff --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,43 @@ +# Contributing + +Thank you for considering giving feedback or contributing to this project. + +There are two ways you can contribute to this repository: + +1. **Creating or commenting on issues**: If you spot a mistake or notice inconsistencies, please feel free to create a new issue [here](https://github.com/scunning1975/mixtape/issues). You are also welcome to read through the issues submitted by others and to contribute to the discussion. +1. **Proposing changes**: If you are familiar with how GitHub works (or are willing to try), you can submit a pull request with any additions or modifications to the files in this repository. + +For more details on contributing via GitHub, read through the sections below. + +## Contributing through GitHub + +To open issues or pull requests, you will need to create an account on . For pull request, you will also need to have [set up Git](https://happygitwithr.com/install-git.html) on your local machine. + +### Creating or commenting on issues + +Issues are places to track ideas, enhancements, tasks, and to report errors or bugs. To create a new issue: + +1. Go to [the issues tab](https://github.com/scunning1975/mixtape/issues). +1. Search the already posted issues to see if the feedback you are about to give is already posted. +1. If your feedback has not already been brought up, please press the green *New Issue* button to post a new issue. + +### Proposing changes via pull requests + +Changes or additions to files are made via *pull requests* or PRs. For major changes, please open an issue first to discuss what you would like to change. + +To create a pull request, you will need to: + +1. Create a [fork of this repository](https://github.com/scunning1975/mixtape/fork). Forking a repository allows you to freely experiment with changes without affecting the original project. +1. [Clone](https://help.github.com/en/github/creating-cloning-and-archiving-repositories/cloning-a-repository) your fork to your local machine. + ```bash + git clone https://github.com//mixtape.git + ``` +1. Create and switch to a new branch. Make your changes. Commit, and push. + ```bash + git checkout -b "new-branch" + # Make your changes + git add "file-that-changed.do" + git commit -m "The commit message" + git push + ``` +1. Navigate back to GitHub. You will see a yellow banner near the top of your repository. Click on *Compare & Pull Request*. If your pull request closes an issue, add `Fixes #` to the body of the PR so the issue is automatically closed once the PR is accepted. diff --git a/README.md b/README.md index 1ac6032..427ebe0 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,6 @@ # mixtape Data files for Causal Inference: The Mixtape +Contributions are very welcome. You can [read this guide](CONTRIBUTING.md) for more guidance. + Please note that this project is released with a [Contributor Code of Conduct](CODE_OF_CONDUCT.md). By participating in this project you agree to abide by its terms. From c330e32a56f0da6ca15c9f9ac79f1b706f66787c Mon Sep 17 00:00:00 2001 From: Maria Paula Caldas Date: Fri, 17 Apr 2020 21:06:06 +0200 Subject: [PATCH 2/2] Fix command --- CONTRIBUTING.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 73194ff..1b9c930 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -34,10 +34,10 @@ To create a pull request, you will need to: ``` 1. Create and switch to a new branch. Make your changes. Commit, and push. ```bash - git checkout -b "new-branch" + git checkout -b new-branch # Make your changes git add "file-that-changed.do" git commit -m "The commit message" - git push + git push origin new-branch ``` 1. Navigate back to GitHub. You will see a yellow banner near the top of your repository. Click on *Compare & Pull Request*. If your pull request closes an issue, add `Fixes #` to the body of the PR so the issue is automatically closed once the PR is accepted.