diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..9436cdc --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,8 @@ +# How to contribute: +If you are familiar with how GitHub works, please feel free to make a fork and submit a pull request for any additions you want to make. Skip to the [Pull-request contributions](#pull-request-contributions) if you are familiar with GitHub and want to do this. + +## Bug reports and feature requests +An easy but still very efficient way to provide any feedback to this tutorial that does not require any GitHub knowledge is to create an *issue*. You can read *issues* submitted by other users or create a new *issue* [here](https://github.com/kbjarkefur/GitHubDropBox/issues). While the word *issue* has a negative connotation outside GitHub, it can be used for any kind of feedback. Please read already existing *issues* to check whether someone else has made the same suggestion or reported the same error before creating a new *issue*. + +# Pull-request contributions +In addition to using common GitHub practices, please follow these conventions to make it possible to keep an overview of the progress made to the code in this toolkit. diff --git a/README.md b/README.md index 302b113..4d0e2c7 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,8 @@ # Tutorial on how to combine GitHub and DropBox +#### Contributions to the tutorial is very welcomed! +We greatly appreciate any type of feedback or contribution to this repository. Either open an [issue](https://github.com/kbjarkefur/GitHubDropBox/issues) if you have a comment/suggestion/bug you want to draw our attention to, or create a fork and submit a pull request if you want to edit language, improve how something is explained, or add to the common issue solution or best practices in the _Resources_ folder. See [CONTRIBUTING.md](CONTRIBUTING.md) for more details. + ### Introduction For good or for bad, in research we often want to use both DropBox and GitHub. Usually the DropBox folder include many folders in addition to the data folder - the folder with files relevant to GitHub. The other folders have files like budget excel sheets, concept notes, contracts with survey firms etc.