Contributing to Drifty

Drifty is an Open-Source project, and we encourage contributions from the community. Thank you for considering and taking the time to contribute! The following are the guidelines for contributing to this project.

Code of Conduct

We have a Code of Conduct  that all contributors must follow. This code of conduct outlines our expectations for participants within the project. It also includes steps to report unacceptable behavior. We are committed to providing a welcoming and inspiring community for all and expect our code of conduct to be honored. Anyone who violates or has concerns about the code of conduct should report it directly to the project maintainers.

How to Report Bugs and Issues

To report any bugs or any difficulties you are facing, you can create an issue by following the below steps 👇

1. Go to the issues  tab of the drifty project on GitHub
2. Click on the new issue  button
3. Choose the relevant category of the issue which you would like to raise
4. Provide as much information as possible, including screenshots, text output, and both your expected and actual results.

What does each Issue Category mean?

1. Bug Report for Application: You can create a Bug Report for Application to report any bug related to the application, including installation problems and crashes.
2. Bug report for Website: You can create an issue in this category if you encounter any bugs or issues in the official website of Drifty .
3. Documentation Change Request: Raise an issue if you think any improvements can be made in the Documentation of Drifty.
4. Feature Request for Drifty Application: If you have any ideas to improve the application by adding new features, you can create an issue in this category.
5. Feature Request for Drifty Website: If you have any ideas to improve the Website of Drifty by adding new features, you can create an issue in this category.

If none of the above categories applies to your case, feel free to create an issue in the Others category.

Pull Requests

Pull requests  are a fantastic way to bring your ideas to life in this project! Start by opening an issue to describe your proposed changes and discuss them with the maintainers. Once the issue is assigned to you, you can go ahead and submit your pull request.

Things to keep in mind while creating a Pull Request

1. Before opening a pull request, please ensure that each commit is signed off using the Developer Certificate of Origin (DCO) (i.e., by using the -s or --signoff flag with -S or --gpg-sign). This confirms that you have the rights to contribute the code under the project’s licensing terms. For more information, please see GitHub’s guide on commit signoffs.
2. Please ensure that your pull request is linked to an issue. If the issue does not exist, please create one.
3. If your task is not yet complete, please mark it as a draft pull request. This will help the maintainers to understand that the task is still in progress.
4. Please fill out the Pull Request Template while creating a Pull Request. This will help the maintainers to understand the changes you have made and the purpose of the Pull Request.

What does each Label mean in Issues and Pull Requests?

1. App 💻 ᠆ This label indicates that changes are made in the Application code
2. bug 🐛 ᠆ This label indicates that changes are made to fix a bug
3. dependencies 📦️ ᠆ This label indicates that dependencies are updated in a Pull Request
4. docker 🐋 ᠆ This label indicates that changes are made in the Dockerfiles
5. documentation 📝 ᠆ This label indicates that changes are made in the documentation
6. good first issue ᠆ This label indicates that the issue is suitable for beginners to start contributing
7. help wanted ᠆ This label indicates that the issue requires help from the community
8. invalid ᠆ This label is used to mark an issue or Pull Request as invalid, meaning it does not meet the project’s guidelines or is not relevant to the project’s goals.
9. CI/CD 🔁 ᠆ This label indicates that changes are made in the CI/CD workflows (GitHub Actions)
10. duplicate ᠆ This label indicates that the issue / Pull Request is duplicate
11. hacktoberfest ᠆ This label indicates that the issue is a part of Hacktoberfest 
12. hacktoberfest-accepted ᠆ This label indicates that the Pull Request is accepted for Hacktoberfest  and will count towards your participation

Project Insights: Status and Task Progress

Projects Tab  lists the tasks completed, in progress and the ideas left to be incorporated in the project. You can work on the to-do tasks by creating the issue (if not already created) and getting yourself assigned.