Adding link to existing contribution guide to README.md file, and making adjustments to guide #2689
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
Adding new contribution section
Added two new sections: FAQ and Issue section. These will help duplication of issues by new users and pinpoint where new users can start working on issues.
Project has an existing CONTRIBUTING.md document.
Added link to existing contributiing.md file
Adding some minor changes to the existing Contributing Guide, such as including links to the main headers of the document, expanding on the bug report section, expanding on the fixing existing issues section.
|
Thank you. |
iChenLei
approved these changes
May 30, 2022
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.
What: I am modifying the documentation for the project:
Why: When I first started looking at this project, I noticed there wasn't a contribution guide at first. I started working on my own guide but then realized there was an existing guide. I wanted to add better visibility to this guide on the README.md file as other projects do.
How: using GitHub's editor
Checklist: