Skip to content

Latest commit

 

History

History
61 lines (42 loc) · 4.36 KB

Contributing.md

File metadata and controls

61 lines (42 loc) · 4.36 KB
Raw

Guide for Contributors

Welcome to Our Physi-c-Tech project 👋
Thankyou Your eagerness to contribute is greatly appreciated.
This guide will walk you through the steps to begin working on the project and successfully make your first contribution.

Line

How You Can Contribute?

🐞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.

📝Documentation : Contributors can contribute by reviewing and improving project documentation. This includes updating existing documents, creating new guides or tutorials, and ensuring that the documentation is clear, comprehensive, and user-friendly.

✨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.

Line

Contributing Guidelines [contributions welcome]

When contributing to this repository, please first discuss the change you wish to make via an issue.

Do not open issues for general support questions as we want to keep GitHub issues for bug reports and feature requests. Remember that this is an inclusive community, committed to creating a safe, positive environment.

Submitting or Requesting an Issue/Enhancement

Best Practices for reporting or requesting for Issues/Enhancements:

  • Before you submit an issue, please search , maybe an issue for your problem already exists and the discussion might inform you of workarounds readily available.
  • Follow the Issue Template while creating the issue.
  • Include Screenshots if any (specially for UI related issues).
  • For UI enhancements or workflows, include mockups to get a clear idea.

Best Practices for getting assigned to work on an Issue/Enhancement:

  • If you would like to work on an issue, inform in the issue ticket by commenting on it.
  • Please be sure that you are able to reproduce the issue, before working on it. If not, please ask for clarification by commenting or asking the issue creator.

Note: Please do not work on an issue which is already being worked on by another contributor. We don't encourage creating multiple pull requests for the same issue.

Submitting a Pull Request

Best Practices to send Pull Requests:

  • Follow the Pull request template and submit a pull request with a motive for your change and the method you used to achieve it to be merged with the master branch.

  • If you can, please submit the pull request with the fix or improvements including tests.

  • During review, if you are requested to make changes, rebase your branch and squash the multiple commits into one. Once you push these changes the pull request will edit automatically.

  • IMPORTANT: Don't make any type of Pull Request until & unless you get assigned to an Issue

  • 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!!

Line

Require further assistance?

Feel free to explore the basics of Git and Github through the provided articles. Additionally, don't hesitate to reach out to the Project Mentors if you encounter any obstacles:
How to create a Issue
Forking a Repo
Cloning a Repo
How to create a Pull Request
Getting started with Git and GitHub