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 (opens in a new tab) 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 👇
- Go to the issues (opens in a new tab) tab of the drifty project on GitHub
- Click on the new issue (opens in a new tab) button
- Choose the relevant category of the issue which you would like to raise
- Provide as much information as possible, including screenshots, text output, and both your expected and actual results.
What does each Issue Category mean?
- 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.
- 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 (opens in a new tab).
- Documentation Change Request: Raise an issue if you think any improvements can be made in the Documentation of Drifty.
- 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.
- 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 (opens in a new tab) 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.
What does each Label mean in Issues and Pull Requests?
- App 💻 This label indicates that changes are made in the Application code
- bug 🐛 This label indicates that changes are made to fix a bug
- dependencies 📦️ This label indicates that dependencies are updated in a Pull Request
- docker 🐋 This label indicates that changes are made in the Dockerfiles
- documentation 📝 This label indicates that changes are made in the documentation
- good first issue This label indicates that the issue is suitable for beginners to start contributing
- help wanted This label indicates that the issue requires help from the community
- 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.
- CI/CD 🔁 This label indicates that changes are made in the CI/CD workflows (GitHub Actions)
- duplicate This label indicates that the issue / Pull Request is duplicate
- hacktoberfest This label indicates that the issue is a part of Hacktoberfest (opens in a new tab)
- hacktoberfest-accepted This label indicates that the Pull Request is accepted for Hacktoberfest (opens in a new tab) and will count towards your participation
Project Insights: Status and Task Progress
Projects Tab (opens in a new 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.