Enhance contribution instructions in README #3518
Closed
+114
−0
Conversation
This file contains hidden or 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
Added detailed contribution guidelines to the README.
nitinyadav2188
temporarily deployed
to
Pages Preview
GitHub Actions
Inactive
There was a problem hiding this comment.
Pull Request Overview
This PR enhances the README by adding comprehensive contribution guidelines and a detailed features section. The changes provide step-by-step instructions for new contributors and better document the project's capabilities.
- Added detailed "How to Contribute Code" section with 10-step workflow
- Introduced comprehensive "Features" section documenting project capabilities
- Enhanced documentation structure to improve contributor onboarding
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
| 2. **Clone Your Fork** | ||
| Clone your forked repository to your local machine: | ||
| ```bash | ||
| https://github.com/github/opensource.guide.git |
There was a problem hiding this comment.
Missing git clone command. The URL should be preceded by the git clone command.
Suggested change
| https://github.com/github/opensource.guide.git | |
| git clone https://github.com/github/opensource.guide.git |
Copilot uses AI. Check for mistakes.
|
We have CONTRIBUTING.md for this. |
|
Urs is much complicated for begginers to understand that's why I created a simple way guide for it |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Added detailed contribution guidelines to the README.
Please note: we will close your PR without comment if you do not check the boxes above and provide ALL requested information.