diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 02fe936..3cccc6b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -4,9 +4,19 @@ By reading and adhering to these guidelines 📃, we can ensure that the contribution process is smooth and beneficial for all.✨ +> And if you like the project, but just don't have time to contribute, that's fine. There are other easy ways to support the project and show your appreciation, which we would also be very happy about: +> - Star the project +> - Tweet about it +> - Refer this project in your project's readme +> - Mention the project at local meetups and tell your friends/colleagues + - [Contributing to awesome green project](#contributing-to-awesome-green-project) - [Code of Conduct](#code-of-conduct) - [Getting Started](#getting-started) + - [I Want To Contribute](#i-want-to-contribute) + - [Working on existing issue](#working-on-existing-issue) + - [Submit an issue to work on new task](#submit-an-issue-to-work-on-new-task) + - [Before Submitting a Bug Report](#before-submitting-a-bug-report) ## Code of Conduct @@ -17,3 +27,24 @@ We value our open-source community 👥 and maintain high standards of communica 🔄 Contributions to this repository are made through Issues and Pull Requests (PRs). Here are some general guidelines to follow for both: - Before creating your own, search 🔍 for existing Issues and PRs. + +## I Want To Contribute + +> ### Legal Notice +> When contributing to this project, you must agree that you have authored 100% of the content, that you have the necessary rights to the content and that the content you contribute may be provided under the project license. + +#### Working on existing issue + +1. Start by forking the project by pressing the fork icon on GitHub. +2. If the project is already forked, make sure to keep it synced. +3. Clone the project locally. +4. Create a branch named issue_number-title, for example 1-welcome-to-first-issue. And, this name can also be generated using GitHub issues. +5. Updated your changes, and open a Pull Request. + +#### Submit an issue to work on new task + +##### Before Submitting a Bug Report + +A good bug report shouldn't leave others needing to chase you up for more information. Therefore, we ask you to investigate carefully, collect information and describe the issue in detail in your report. + +Continue with the process of [Working on existing issue](#working-on-existing-issue)