wucket/awesome-for-beginners
1
0
Fork 0
mirror of https://github.com/MunGell/awesome-for-beginners.git synced 2025-12-10 16:22:12 +00:00
Code Issues Packages Projects Releases Wiki Activity

Remove duplicate steps and points from CONTRIBUTING.md

Browse Source
This commit is contained in:
Sammy Hori 2025-04-25 00:02:01 +01:00 committed by GitHub
parent 828d19836a
commit cd625877e9
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 5 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
CONTRIBUTING.md
View File

@ -38,28 +38,17 @@ The easiest way to contribute is by editing the `data.json` file directly in you
- **New Technologies**: New technologies are welcomed, all you need to do is add them and a new heading will be generated for them. - **New Technologies**: New technologies are welcomed, all you need to do is add them and a new heading will be generated for them.
4. Describe your changes concisely in the commit message. 4. Describe your changes concisely in the commit message.
5. Click **"Propose changes"** to create a new branch and open a Pull Request (PR). 5. Click **"Propose changes"** to create a new branch and open a Pull Request (PR).
GitHub will guide you through the rest of the process to submit your PR. Ensure your PR's content (especially the title) is understandable, descriptive and relevant.
If your suggest repository uses a non-obvious beginner-friendly issue label, ensure to link to confirmation or proof that the label is beginner friendly.
--- ---
### 2. **Submitting a Pull Request (PR)** ### 2. **Submitting a Pull Request (PR)**
1. After proposing changes, GitHub will guide you through creating a PR. 1. After proposing changes, GitHub will guide you through creating a PR.
2. Fill out the PR form with a clear description of your changes. 2. Fill out the PR form, ensuring its content (especially the title) is understandable, descriptive and relevant.
3. Submit the PR and wait for feedback from the maintainers. 3. If your suggest repository uses a non-obvious beginner-friendly issue label, ensure to link to confirmation or proof that the label is beginner friendly.
4. Submit the PR and wait for feedback from the maintainers.
--- ---
### 3. **Best Practices** ### 3. **Reporting an Issue**
- **Follow the Repository Requirements**: Ensure your contribution adheres to the specific requirements of this repository.
- **Avoid Duplicates**: Check if your suggestion has already been proposed.
- **Be Clear and Concise**: Provide a detailed description of your changes.
---
### 4. **Reporting an Issue**
If you encounter an issue or have a suggestion that you don't want to implement yourself, open an issue ensuring you provide: If you encounter an issue or have a suggestion that you don't want to implement yourself, open an issue ensuring you provide:
- A clear description of the problem or suggestion. - A clear description of the problem or suggestion.
- The expected behavior (if creating a feature request or bug report). - The expected behavior (if creating a feature request or bug report).
@ -67,7 +56,7 @@ If you encounter an issue or have a suggestion that you don't want to implement
--- ---
### 5. **Additional Resources** ### 4. **Additional Resources**
For a more comprehensive guide on contributing to open-source projects, check out the [First Contributions](https://github.com/firstcontributions/first-contributions) repository. For a more comprehensive guide on contributing to open-source projects, check out the [First Contributions](https://github.com/firstcontributions/first-contributions) repository.
--- ---