Create the contribution guide #11
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This commit introduces the initial draft of our contribution guide. The plan is to keep updating it as the project evolves, addressing any commonly asked questions and providing additional clarification as needed. The guide is inspired by the excellent contribution guide from Hack For LA. It has been heavily simplified to better suit the goals of our project of accessibility, by attempting to not overwhelm new developers with too much information.
Closed
|
|
||
| **For example:** `https://github.com/octocat/SAGP`. | ||
|
|
||
| **Be Aware:** What you have created is a forked copy in a remote version on GitHub. It is not on your local machine yet. |
There was a problem hiding this comment.
For newer developers and for convenience, add a link on how to clone a repository. The official docs should be sufficient: https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository
There was a problem hiding this comment.
Nice one! I'll add a section for that
There was a problem hiding this comment.
Thanks for the suggestion. I added it under commit 4a0fc8a.
Before, there were only general guidelines and a brief intro into what a Code Review is. Now, detailed instructions with images were added for reviewers.
matthiasjrichter
approved these changes
Nov 22, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR introduces the initial draft of our contribution guide.
The plan is to keep updating it as the project evolves, addressing any
commonly asked questions and providing additional clarification as
needed.
The guide is inspired by the excellent contribution guide from Hack For
LA. It has been heavily simplified to better suit the goal of our
project of making contribution accessible to all, by attempting to not
overwhelm new developers with too much information.
In addition to the guide, a Pull Request template was added to streamline
the creation process.
Closes #4
Type of change