From 0fb9309ed0d10af8a5065ee0b6f742012f7d330f Mon Sep 17 00:00:00 2001 From: Armaan <104704093+0Armaan025@users.noreply.github.com> Date: Tue, 31 Oct 2023 23:33:32 +0530 Subject: [PATCH] Create CONTRIBUTING.md --- CONTRIBUTING.md | 92 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 92 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..eba09aaf --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,92 @@ +# Contributing to Easy-Wi Developer + +Welcome to the Easy-Wi Developer repository. Your contributions can help enhance and improve this development environment, making it even more powerful and user-friendly. To ensure a smooth and collaborative experience, please follow the contribution guidelines outlined below. + +## **Submitting Contributions** + +To contribute to this project, please follow these steps: + +### **1. Choose or Create an Issue** + +- Start by reviewing the existing issues to identify areas where your contributions can make a significant impact. +- If you have new features, enhancements, or bug fixes in mind, you can create a new issue to propose your contributions. Please provide comprehensive details to clearly explain your ideas. + +### **2. Fork the Repository** + +- To initiate your contribution, fork the primary repository by clicking the "Fork" button. This will create a copy of the repository in your personal GitHub account. + +### **3. Clone Your Forked Repository** + +- Clone your forked repository to your local development environment using the following command: + +```bash +git clone https://github.com/your-username/developer.git +``` + +### **4. Set Up the Upstream Remote** + +- Keep a reference to the primary project by adding it as the upstream remote: + +```bash +cd developer +git remote add upstream https://github.com/easy-wi/developer +git remote -v +``` + +### **5. Create a New Branch** + +- Before you start working on your contribution, create a new branch dedicated to your specific task: + +```bash +git checkout -b my-contribution +``` + +## **Working on Your Contribution** + +Now that your development environment is set up and a new branch is created, you can begin working on your contribution. Please ensure you adhere to the following guidelines: + +### **6. Make Changes** + +- Implement the necessary changes, including code additions, enhancements, or bug fixes. Ensure your contributions are well-structured, documented, and aligned with the project's objectives. + +### **7. Commit Your Changes** + +- Commit your changes using informative commit messages that clearly convey the purpose of your contributions: + +```bash +git commit -m "Add a descriptive message here" +``` + +### **8. Push Your Changes** + +- Push the committed changes to your branch in your remote repository on GitHub: + +```bash +git push origin my-contribution +``` + +### **9. Create a Pull Request** + +- Visit your repository on GitHub and click the "New Pull Request" button to initiate a pull request from your branch to the primary repository. + +### **10. Await Review** + +- Your pull request will undergo review, and feedback will be provided by the project maintainers or fellow contributors. Be prepared to address any suggested changes or refinements. + +## **Community Engagement** + +While contributing, consider engaging with the community in the following ways: + +### **11. Join Discussions** + +- Participate in discussions related to Easy-Wi Developer, share your insights, and collaborate with others to enhance the development environment's features and capabilities. + +### **12. Share Ideas** + +- If you have innovative ideas for advancing the project or optimizing the development environment, such as new features or optimizations, feel free to open issues to initiate productive discussions. + +## **Acknowledgment** + +We appreciate your dedication to improving Easy-Wi Developer. Your contributions are essential for the project's development and success. If you have questions or require assistance, please don't hesitate to contact the project maintainers. + +Thank you for your valuable contributions, and we eagerly anticipate collaborating with you on the Easy-Wi Developer project! 🚀🔧🙌