Add contributing guidelines #14
Conversation
Starting a CONTRIBUTING.md that includes ways people can contribute to the project. This includes discussions, issues, pull requests and translations (in the future). Detailed step by step instructions on opening a Pull Request from the GitHub user interface. Lots of these were adapted from https://github.com/github/docs/blob/main/contributing/types-of-contributions.md
|
Super nice work @weiji14 ! Thanks a lot! 😄 |
| 1. [Login](https://github.com/login) to your GitHub account, | ||
| or sign up for a new one at https://github.com/signup. | ||
|
|
||
| 2. Navigate to the file you want to modify, e.g. the | ||
| [Sentinel-2 JSON file](https://github.com/APECS-Earth-Observation/Polar-EO-Database/blob/main/data/Sentinel-2.json). | ||
|
|
||
| 3. Click on the pen :pen: icon on the top right corner that says "Edit this file" | ||
|
|
||
| 4. This should bring you to a page like | ||
| https://github.com/APECS-Earth-Observation/Polar-EO-Database/edit/main/data/Sentinel-2.json | ||
| where you can make edits to the text using a web-based editor. | ||
| Feel free to switch between the "Edit file" and "Preview changes" tabs as | ||
| you modify the content to make sure things look ok. |
There was a problem hiding this comment.
A little unsure on how this looks like for someone who needs to fork the repo first. @AdrienWehrle, could you use your bot account to double check if there's any extra steps needed here?
There was a problem hiding this comment.
There is no need to fork. The patch is created automatically on commit!
There was a problem hiding this comment.
So it's literally commit + PR only!
There was a problem hiding this comment.
You can have a look at the video I sent on the slack to see how do things look like on the contributor side! 😄
There was a problem hiding this comment.
Hmm, it looks like there are some little differences in some of those points for when a new user makes a change. I'll look at your video closer and try to edit the steps later.
|
Let's keep this PR open until after the meeting, in case anyone has any feedback. |
|
Sounds good! 👍 |
|
I'm not sure the screen recording of the PR process would add a lot, your description is very clear and already includes screenshots! What do you think? |
Still think a screen recording is good to have, people learn in different ways (video/text) so we should have both! |
|
Ok! Let's include it in another PR! |
Starting a CONTRIBUTING.md that includes ways people can contribute to the project. This includes discussions, issues, pull requests and translations (in the future). Detailed step by step instructions on opening a Pull Request from the GitHub user interface. Lots of these were adapted from https://github.com/github/docs/blob/main/contributing/types-of-contributions.md
Addresses #9.