Welcome to my Arctic Delights project! 🍨
We appreciate your interest in contributing.😊
This guide will help you get started with the project and make your first contribution.
🐞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.
-
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.
- Drop a Star ⭐ in this repo
- Take a look at the existing 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, 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 anIssue
- 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 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
You can refer to the following articles on basics of Git and Github and also contact the Project Mentors, in case you are stuck:
How to create a Issue
Forking a Repo
Cloning a Repo
How to create a Pull Request
Getting started with Git and GitHub
It always takes time to understand and learn. So, don't worry at all. We know you have got this! 💪