Skip to content

Latest commit

 

History

History
87 lines (61 loc) · 5.01 KB

CONTRIBUTING.md

File metadata and controls

87 lines (61 loc) · 5.01 KB
Raw

🎇Contributing Guidelines

Thank you for considering contributing to the PES-Wayfinder project! We welcome your help to make our navigation app even better. Whether you're a developer, designer, tester, or simply have great ideas, your contributions are valuable to us. This documentation contains a set of guidelines to help you during the contribution process.

Please follow this guide to get started with contributing:

🔖Getting Started (Steps to Contribute)

  1. Fork the PES-Wayfinder repository to your GitHub account.

  2. Clone the forked repository to your local machine:

    git clone https://github.com/your-username/pes-wayfinder.git

  3. Create a new branch for your work:

    git checkout -b feature/your-feature-name

  4. Make your changes, commit them, and push to your forked repository:

    git add .
git commit -m "Add your descriptive commit message here"
git push origin feature/your-feature-name

  5. Open a pull request (PR) from your forked repository to the main project's main branch.

🔨Note:

  • Do not edit/delete someone else's code in this repository. You can only insert new files/folders in this repository.
  • Give a meaningful name to whatever file or folder you are adding. (For example, if you have written an AI code on Loan Prediction, then loan_prediction.ipynb is one example of a valid name)

🔑Guidelines

  1. Follow the code of conduct in all your interactions with the project.
  2. Ensure your code adheres to the project's coding standards and style.
  3. Write clear and concise commit messages.
  4. Provide detailed PR descriptions, explaining the purpose of your changes and any relevant context.
  5. Participants/contributors have to comment on issues they would like to work on, and mentors or the PA will assign you.
  6. Issues will be assigned on a first-come, first-serve basis.
  7. Participants/contributors can also open their issues using [issue_template], but it needs to be verified and labeled by a mentor or PA. Please discuss with the team once before opening your issues. We respect all your contributions, whether it is an issue or a pull request.
  8. When you raise an issue, make sure you get it assigned to you before you start working on that project.
  9. Each participant/contributor will be assigned 1 issue (max) at a time to work.
  10. Participants are expected to follow project guidelines . Structured code is one of our top priorities.
  11. Try to explain your approach to solve any issue in the comments. This will increase the chances of you being assigned.
  12. Don't create issues that are already listed.
  13. Please don't pick up an issue already assigned to someone else. Work on the issues after it is assigned to you.
  14. Make sure you discuss issues before working on the issue.
  15. Pull requests will be merged after being reviewed by a mentor or PA.
  16. It might take a day or two to review your pull request. Please have patience and be nice.
  17. Always create a pull request from a branch other than main.
  18. Participants/contributors have to complete issues before the decided deadline. If you fail to make a PR within the deadline, then the issue will be assigned to another person in the queue.
  19. While making PRs, don't forget to add a description of your work.
  20. Include issue number (Fixes:issuenumber) in your commit message while creating a pull request.
  21. Make sure your solution to any issue is better in terms of performance and other parameters in comparison to the previous work.
  22. We all are here to learn. You are allowed to make mistakes. That's how you learn,so don't be afraid to ask for help or guidance from the mentors or the community.

🧲Pull Requests Review Criteria

  1. Please fill the [PR Template] properly while making a Pull Request.
  2. You must add your code .ipynb file into the respective folders.
  3. Your work must be original, written by you, not copied from other resources.
  4. You must comment on your code where necessary.
  5. For frontend changes, kindly share screenshots and work samples of your work before sending a PR.
  6. Follow the proper style guides for your work.
  7. For any queries or discussions, please feel free to drop a message.

🤔Need more help?

You can refer to the following articles on the basics of Git and Github and also contact the admins or mentors in case you are stuck:

🎉 🎊 😃 Happy Contributing 😃 🎊 🎉
🎉 🎊 😃 Happy Navigating 😃 🎊 🎉