Merge pull request #1604 from MunGell/update-contribution-guide

Improve the Contribution Guide with input from several people and PRs
Remove duplicate steps and points from CONTRIBUTING.md
2026-01-23 20:08:09 -08:00 · 2025-04-25 00:03:09 +01:00 · 2025-04-25 00:02:01 +01:00 · 2025-04-24 23:57:39 +01:00 · 2025-04-24 21:15:28 +00:00 · 2025-04-24 22:15:16 +01:00
3 changed files with 65 additions and 28 deletions
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -1,19 +1,64 @@
-# Contribution Guidelines
+# Contribution Guide & Guidelines 🚀

-Please ensure that your pull request adheres to the following guidelines:
+Welcome to the **Awesome First Pull Request Opportunities** project! We're excited that you want to contribute.

- Search previous suggestions before making a new one to avoid duplicates.
- Ensure your contribution is useful and relevant, with sufficient content and a clear, concise description for each item. Make sure your contribution is useful and relevant before submitting. That implies it has enough content and every item has a good succinct description.
- Make an individual pull request for each suggestion.
- Only include your suggested repository to `data.json` file, README.md file is generated from it.
- New categories or improvements to existing categories are welcome.
- Check your spelling and grammar.
- Make sure your text editor is set to remove trailing whitespace.
- The pull request and commit should be given a meaningful title.
- Ensure that you describe your pull request.
- If the label does not clearly state its "beginner-friendly" purpose, confirm with the maintainer that it is used for such issues. Include a link to where the maintainer approves this.
- Maintainer confirmation is also required in case repository has more than one beginner-friendly-like label (e.g. `low-hanging-fruit` and `up-for-grabs`).
- Ensure the contributed repository is actively maintained, has a supportive community, and issues with appropriate labels.
- Links must be pointing directly to the repository, no tracking links allowed. This list is not for advertising purposes.
+This guide aims to help you get started contributing new repositories to the list.

-Thank you for your suggestions!!
+It outlines the recommended order for executing tasks and assumes that you have identified a repository you wish to add to the list. Check out the repository requirements section, if you would like to know what a good addition should have.
+
+_Please note that the list in this repository is intended for more substantial projects, and we kindly ask that small personal projects not be added in the hope of receiving contributions. Thank you for your understanding._
+
+## Intitial Checks
+
+- **Search for Duplicates**: Check the current list and previous pull requests to avoid submitting duplicates.
+
+## Repository Requirements
+
+- **Reasonably Developed**: The repository must be reasonably established, along with having with a clear goal or function. New repositories with few commits and little content will likely be rejected.
+- **Active Maintenance**: Ensure the contributed repository is actively maintained.
+- **Appropriate Labels**: Issues with appropriate beginner-friend labels must exist. Confirm with the owner around a label's meaning if it's not obviously beginner-friendly (usually `good-first-issue` or `low-hanging-fruit`).
+- **Supportive Community**: The repository should have a supportive community.
+
+## Making Changes and Opening a PR (Pull Request)
+
+### 1. **Edit the `data.json` File Directly on GitHub**
+The easiest way to contribute is by editing the `data.json` file directly in your browser. Here's how:
+
+1. Go to the [`data.json` file](https://github.com/MunGell/awesome-for-beginners/blob/main/data.json) in the repository.
+2. Click the **"Edit"** button (pencil icon) in the top right corner.
+3. Make your changes directly in the browser:
+   - Copy an existing entry in the file.
+   - Fill in your own information following the same format.
+   - Ensure to check the following:
+       - **Direct Links**: Links must point directly to the repository. No tracking links are allowed. This list is not for advertising purposes.
+       - **Spelling and Grammar**: Proofread your contribution for spelling and grammar errors.
+       - **Trailing Whitespace**: Ensure to avoiding adding any trailing whitespace (at the end of lines).
+       - **Spelling and Grammar**: Proofread your contribution for spelling and grammar errors.
+       - **Single addition**: Make an individual pull request for each suggestion.
+       - **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.
+5. Click **"Propose changes"** to create a new branch and open a Pull Request (PR).
+---
+
+### 2. **Submitting a Pull Request (PR)**
+1. After proposing changes, GitHub will guide you through creating a PR.
+2. Fill out the PR form, ensuring its content (especially the title) is understandable, descriptive and relevant.
+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. **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:
+- A clear description of the problem or suggestion.
+- The expected behavior (if creating a feature request or bug report).
+- The current behavior (if creating a bug report).
+
+---
+
+### 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.
+
+---
+
+Thank you for your contribution!
--- a/README.md
+++ b/README.md
@@ -276,6 +276,7 @@ If you would like to be guided through how to contribute to a repository on GitH
 - [Colossal-AI](https://github.com/hpcaitech/ColossalAI) _(label: good first issue)_ <br> An open-source deep learning system for large-scale model training and inference with high efficiency and low cost.
 - [cookiecutter](https://github.com/cookiecutter/cookiecutter) _(label: good first issue)_ <br> A command-line utility that creates projects from cookiecutters (project templates). E.g. Python package projects, jQuery plugin projects.
 - [datascience](https://github.com/data-8/datascience) _(label: good first issue)_ <br> A Jupyter notebook Python library for introductory data science.
+- [Devopness](https://github.com/devopness/devopness) _(label: good first issue)_ <br> Deploy any software to any cloud: automated DevOps workflows to save software teams time and money.
 - [django cookiecutter](https://github.com/pydanny/cookiecutter-django) _(label: hacktoberfest)_ <br> An implementation of Python for backend web development.
 - [Embedchain](https://github.com/embedchain/embedchain/) _(label: good first issue)_ <br> Embedchain is a framework to easily create LLM powered bots over any dataset.
 - [Fabric](https://github.com/fabric/fabric) _(label: Low-hanging-fruit)_ <br> Pythonic remote execution and deployment.
@@ -330,7 +331,6 @@ If you would like to be guided through how to contribute to a repository on GitH
 - [a-b-street](https://github.com/a-b-street/abstreet) _(label: good first issue)_ <br> Transportation planning and traffic simulation software for creating cities friendlier to walking, biking, and public transit.
 - [dotenv-linter](https://github.com/dotenv-linter/dotenv-linter) _(label: good first issue)_ <br> Lightning-fast linter for .env files. Written in Rust
 - [Hyper](https://github.com/hyperium/hyper) _(label: E-easy)_ <br> A fast, safe and correct low-level HTTP library for Rust.
- [Iron](https://github.com/iron/iron) _(label: easy)_ <br> An extensible, concurrent web framework for Rust
 - [nushell](https://github.com/nushell/nushell) _(label: good first issue)_ <br> A modern shell for the GitHub era written in Rust.
 - [Ockam](https://github.com/ockam-network/ockam) _(label: good first issue)_ <br> End-to-end encryption and mutual authentication for distributed applications.
 - [Readest](https://github.com/readest/readest) _(label: good first issue)_ <br> A modern, feature-rich ebook reader designed for avid readers offering seamless cross-platform access, powerful tools, and an intuitive interface.
@@ -362,7 +362,7 @@ If you would like to be guided through how to contribute to a repository on GitH
 - [Amplication](https://github.com/amplication/amplication) _(label: good first issue)_ <br> Amplication is an open-source development tool. It helps you develop quality Node.js applications without spending time on repetitive coding tasks.
 - [Berry - Active development trunk for Yarn](https://github.com/yarnpkg/berry) _(label: good first issue)_ <br> Fast, reliable, and secure dependency management.
 - [Booster](https://github.com/boostercloud/booster) _(label: good first issue)_ <br> A truly serverless framework, write your code and deploy it in seconds without any server configuration files.
- [Devopness](https://github.com/devopness/devopness) _(label: good first issue)_ <br> Devopness aims to drastically simplify the way we manage cloud applications and multi cloud infrastructure in a secure and productive way.
+- [Devopness](https://github.com/devopness/devopness) _(label: good first issue)_ <br> Deploy any software to any cloud: automated DevOps workflows to save software teams time and money.
 - [Graphback](https://github.com/aerogear/graphback) _(label: good first issue)_ <br> A CLI and runtime framework to generate a GraphQL API in seconds.
 - [H2O Wave](https://github.com/h2oai/wave) _(label: good first issue)_ <br> Realtime Web Apps and Dashboards framework for Python and R. Suited (not only) for AI audience.
 - [Hasura GraphQL Engine](https://github.com/hasura/graphql-engine) _(label: good first issue)_ <br> Blazing fast, instant realtime GraphQL APIs on Postgres with fine grained access control, also trigger webhooks on database events.
--- a/data.json
+++ b/data.json
@@ -1063,9 +1063,10 @@
            "link": "https://github.com/devopness/devopness",
            "label": "good first issue",
            "technologies": [
+                "Python",
                "TypeScript"
            ],
-            "description": "Devopness aims to drastically simplify the way we manage cloud applications and multi cloud infrastructure in a secure and productive way."
+            "description": "Deploy any software to any cloud: automated DevOps workflows to save software teams time and money."
        },
        {
            "name": "Julia Language: Help wanted",
@@ -1686,15 +1687,6 @@
            ],
            "description": "A tool for formatting Rust code according to style guidelines."
        },
-        {
-            "name": "Iron",
-            "link": "https://github.com/iron/iron",
-            "label": "easy",
-            "technologies": [
-                "Rust"
-            ],
-            "description": "An extensible, concurrent web framework for Rust"
-        },
 	{
            "name": "TensorZero",
            "link": "https://github.com/tensorzero/tensorzero",
Author	SHA1	Message	Date
Sammy Hori	1acaa13a0c	Merge pull request #1604 from MunGell/update-contribution-guide Improve the Contribution Guide with input from several people and PRs	2025-04-25 00:03:09 +01:00
Sammy Hori	cd625877e9	Remove duplicate steps and points from CONTRIBUTING.md	2025-04-25 00:02:01 +01:00
Sammy Hori	828d19836a	Minor improvement to CONTRIBUTING.md Added a sentence after stating that the guide assumes that the user already has a repository to add to direct those who don't to the repository requirements. This'll hopefully help them in the search for an appropriate repository.	2025-04-24 23:57:39 +01:00
Shmavon Gazanchyan	5b2ff0b352	Update README.md	2025-04-24 21:15:28 +00:00
Sammy Hori	58a3c54017	Merge pull request #1611 from ShahabSL/patch-1 Remove Iron from data.json because of inactivity	2025-04-24 22:15:16 +01:00
Shmavon Gazanchyan	bfa80b3c27	Update README.md	2025-04-24 21:12:28 +00:00
Sammy Hori	956bcf2cab	Merge pull request #1613 from jfoliveira/patch-1 feat: add Python language to `Devopness` repo	2025-04-24 22:12:16 +01:00
jfoliveira	370eb01c60	feat: add Python language to `Devopness` repo	2025-04-24 15:25:10 +01:00
Shahab Lavasani	6725b9632c	Update data.json (deleted Iron project) project's last commit is 4 years ago and it seems it's not active anymore.	2025-04-22 00:29:57 -05:00
Sammy Hori	ac0d9c712b	Improve the Contribution Guide with input from several people This takes a number of suggested changes, using parts from them to improve the guide. Many thanks to hendhamdi, Shadowrithik and omsudhamsh. Co-authored-by: Hend Hamdi <124783023+hendhamdi@users.noreply.github.com> Co-authored-by: Shadowrithik <s.rithikkumarcaprio@gmail.com> Co-authored-by: omsudhamsh <omsudhamsh@gmail.com>	2025-04-17 21:33:21 +01:00