-
Notifications
You must be signed in to change notification settings - Fork 112
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #107 from Amulya-B28/main
Create Contributing.md
- Loading branch information
Showing
1 changed file
with
134 additions
and
0 deletions.
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,134 @@ | ||
| <h1 align="center">✨ Contributors Guide ✨</h1> | ||
| <h3 align="center">Welcome to my 🐍PYTHON VOICE ASSISTANT🐍 project! <br> We appreciate your interest in contributing.😊 <br>This guide will help you get started with the project and make your first contribution.</h3> | ||
|
|
||
|  | ||
|
|
||
| ## What you can Contribute? | ||
|
|
||
| **🐞Bug Fixing :** | ||
| Contributors can help by reviewing and confirming reported issues. This includes verifying bugs, providing additional details, and prioritizing tasks for the development team. | ||
|
|
||
| **✨Enhancements :** | ||
| Contributors can enhance the project by implementing new features or improvements suggested by users. This involves understanding requirements, designing solutions, and extending the functionality of the travel website. 🚀 | ||
|
|
||
| **📝 Documentation :** | ||
| High-quality documentation is essential for the success of the project. Contributions to the documentation help ensure that users and contributors can understand and use the travel website effectively. | ||
|
|
||
|  | ||
|
|
||
| ## 🧾 General Guidelines | ||
|
|
||
| - **Communication**: If you're unsure about a fix or feature, please open an issue or ask questions in the issue’s thread before proceeding. | ||
|
|
||
| - **Documentation**: Make sure to update or add relevant documentation, including comments in the code, if you’re working on a feature. | ||
|
|
||
| - **Testing**: Run tests after implementing your changes and write new ones if necessary. The project uses [testing tool/framework] for verification. | ||
|
|
||
| - **Code Style**: Follow the coding standards outlined in the [style guide](https://docs.github.com/en/contributing/style-guide-and-content-model/style-guide). | ||
|
|
||
| - **Reporting Bugs**: | ||
| If you encounter any bugs, feel free to report them. | ||
|
|
||
| - **Suggesting Features or Enhancements**: | ||
| We welcome new ideas and suggestions! | ||
|
|
||
| - **Submitting Code**: | ||
| Keep your pull requests focused on a single change to make reviews easier. | ||
|
|
||
| - **Commit Message Format**: | ||
| Use meaningful and descriptive commit messages. | ||
|
|
||
|  | ||
|
|
||
| ## Community Guidelines 🤝 | ||
|
|
||
| Please follow these guidelines while contributing: | ||
|
|
||
| - Be respectful and considerate towards others. | ||
| - Use inclusive language and foster a welcoming environment. | ||
| - Avoid personal attacks, harassment, or discrimination. | ||
| - Keep discussions focused on constructive topics. | ||
|
|
||
|  | ||
|
|
||
| ## Important Guidelines ⚡ | ||
|
|
||
| - Contributors should only work on issues that have been assigned to them. | ||
| - Each pull request should be associated with one issue only. | ||
| - No minor text edits should be submitted unless necessary. | ||
| - Unethical behavior, tampering with files, or harassment will result in disqualification. | ||
| - Follow the community guidelines while contributing to ensure a healthy collaborative environment. | ||
|
|
||
|  | ||
|
|
||
|
|
||
|
|
||
| ## How to Contribute? | ||
| - Drop a Star ⭐ in this repo | ||
| - Take a look at the existing [**Issues**](https://github.com/suryanshsk/Python-Voice-Assistant-Suryanshsk/issues). | ||
| - Fork the Repo & create a branch for any issue that you are working on and commit your work. | ||
| - At first raise an issue in which you want to work | ||
| - Then after assigning only then work on that issue & make a PR | ||
| - Create a [**Pull Request**](https://github.com/suryanshsk/Python-Voice-Assistant-Suryanshsk/pulls), which will be promptly reviewed and given suggestions for improvements by the community. | ||
| - **REMINDER: Don't raise more than 2 `Issue` at a time** | ||
| - **IMPORTANT: Don't make any type of `Pull Request` until & unless you get assigned to an `Issue`** | ||
| - Add screenshots or screen captures to your `Pull Request` to help us understand the effects of the changes that are included in your commits. | ||
|
|
||
| Thank you for your contribution!! | ||
|
|
||
|  | ||
|
|
||
| ## Contribution Points | ||
|
|
||
| *🏆 Contribution Levels:* | ||
| All the tasks will be assigned various levels based on the complexity of the task and skills required to complete it. Every level will provide you a different amount of Points that is: | ||
| - **🥇 Level 1**: 10 Points | ||
| - **🥈 Level 2**: 25 Points | ||
| - **🥉 Level 3**: 45 Points | ||
|
|
||
|  | ||
|
|
||
| ## Development Workflow 📈 | ||
|
|
||
| When contributing to this project, please follow these guidelines: | ||
|
|
||
| - Always work on a new branch for each issue or feature. | ||
| - Keep your branch updated with the main repository's master branch. | ||
| - Write clear and concise commit messages. | ||
| - Test your changes thoroughly before submitting a pull request. | ||
| - Keep discussions respectful and constructive. | ||
|
|
||
|  | ||
|
|
||
| ## Issue Report Process 🚩 | ||
|
|
||
| - Go to the project's issues section. | ||
| - Choose the appropriate template for your issue. | ||
| - Provide a clear description of the issue. | ||
| - Wait for someone to look into it before working on it. | ||
| - Work on the issue only after it has been assigned to you. | ||
|
|
||
|  | ||
|
|
||
| ## Pull Request Process 🚀 | ||
|
|
||
| - Ensure that your code is self-reviewed before submitting. | ||
| - Provide a detailed description of the functionality or changes made. | ||
| - Add relevant comments in your code, especially for complex sections. | ||
| - Submit your PR using the appropriate PR template. | ||
|
|
||
|  | ||
|
|
||
| <h2 align="center">Need more help? 🤔</h1> | ||
| <p align="center"> | ||
| You can refer to the following articles on basics of Git and Github and also contact the Project Mentors, in case you are stuck: <br> | ||
| <a href="https://help.github.com/en/desktop/contributing-to-projects/creating-an-issue-or-pull-request">How to create a Issue</a> <br> | ||
| <a href="https://help.github.com/en/github/getting-started-with-github/fork-a-repo">Forking a Repo</a> <br> | ||
| <a href="https://docs.github.com/en/get-started/quickstart/fork-a-repo#cloning-your-forked-repository">Cloning a Repo</a> <br> | ||
| <a href="https://opensource.com/article/19/7/create-pull-request-github">How to create a Pull Request</a> <br> | ||
| <a href="https://docs.github.com/get-started">Getting started with Git and GitHub</a> <br> | ||
| </p> | ||
|
|
||
| <h2 align="center">Tip from us 😇</h1> | ||
| <p align="center">It always takes time to understand and learn. So, don't worry at all. We know <b>you have got this</b>! 💪</p> | ||
| <h3 align="center">Show some ❤️ by 🌟 this repository!</h3> |