Skip to content

Commit

Permalink
Update Contributing section
Browse files Browse the repository at this point in the history
  • Loading branch information
Otto Mättas authored Jul 5, 2021
1 parent e4759bb commit 58bbc4d
Showing 1 changed file with 34 additions and 0 deletions.
34 changes: 34 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -130,6 +130,40 @@ Below, an example workflow pipeline has been described from the perspective of A
## Contributing
//Larger projects often have sections on contributing to their project, in which contribution instructions are outlined. Sometimes, this is a separate file. If you have specific contribution preferences, explain them so that other developers know how to best contribute to your work. To learn more about how to help others contribute, check out the guide for setting guidelines for repository contributors.//

Below, you will find ways to participate and contribute to the field of scientific review.

### What?
Before we get into how to exactly contribute, let's look at what you can actually do.

#### Documentation
First and foremost, this repository is for simplifing the process of setting up a scientific workflow for research. In case you find something that could be simplified further, do not hesitate to work on it. Also, improving documentation is often the quickest way to start contributing.

#### Datasets
We have described the interrelations between popular citation and reference managers, search engines and systematic review software. Additionally, we have gathered [relevant datasets](Datasets/) to show capabilities of each tool more specifically.

### How?
We are using a common workflow shared among many open repositories on Github.
1. Sign in to your Github account
2. Fork the project repository
3. Clone your fork
4. Navigate to your cloned fork repository
5. Check that your fork is the "origin" remote
6. Add the project repository as the "upstream" remote
7. Pull the latest changes from upstream into your local repository
8. Create a new branch
9. Make changes in your local repository
10. Commit your changes
11. Push your changes to your fork
12. Begin the pull request
13. Create the pull request
14. Review the pull request
15. Add more commits to your pull request
16. Discuss the pull request
17. Delete your branch from your fork
18. Delete your branch from your local repository
19. Synchronize your fork with the project repository
20. Have a cookie!

## Credits
//Include a section for credits in order to highlight and link to the authors of your project.//

Expand Down

0 comments on commit 58bbc4d

Please sign in to comment.