Skip to content

Latest commit

 

History

History
115 lines (75 loc) · 3.77 KB

CONTRIBUTING.md

File metadata and controls

115 lines (75 loc) · 3.77 KB
Raw

Contributing Guidelines 📄

This documentation contains a set of guidelines to help you during the contribution process. We are happy to welcome all the contributions from anyone willing to improve/add new scripts to this project. Thank you for helping out and remember, no contribution is too small.
Please note we have a code of conduct please follow it in all your interactions with the project.


Need some help regarding the basics?🤔

You can refer to the following articles on basics of Git and Github and also contact the Project Mentors, in case you are stuck:


Contributing Process

We follow the "fork and pull request" workflow for accepting contributions. To contribute to the project, please follow these steps:

1. Fork the repository to your GitHub account.

Fork

2. Please be careful of this to uncheck "copy only the main"

Uncheck

3.For development related changes,now in your forked REPO checkout to the develop branch.

image

4. Create a folder at your desired location (usually at your desktop).

5. Clone your forked repository of the project.

$ git clone https://github.com/<your_username>/repository_name.git

6. Navigate to the project directory.

$ cd UltimateHealth

7. Checkout to develop branch.

$ git checkout develop

8.Create a new branch for your changes

$ git checkout -b my-branch

9. Make your changes in your code and test them thoroughly.

10.Commit your changes

$ git commit -m "Add descriptive commit message"

11.Push the changes to your forked repository.

$ git push origin my-branch

12.Open a pull request (PR) against the develop repository for code related tasks and main repository for documentation related tasks.


Style Guide

To maintain consistency and readability, please adhere to our style guide when contributing code or documentation. Some key points to keep in mind:

1.Use consistent indentation and spacing.

2.Follow the naming conventions used in the project.

3.Write clear and concise comments.

4.Use meaningful variable and function names.

5.Keep code and documentation formatting consistent.


Issue Report Process 📌

  1. Go to the project's issues.
  2. Give proper description for the issues.
  3. Don't spam to get the assignment of the issue 😀.
  4. Wait for till someone is looking into it !.
  5. Start working on issue only after you got assigned that issue 🚀.

Pull Request Process 🚀

  1. Ensure that you have self reviewed your code 😀
  2. Make sure you have added the proper description for the functionality of the code
  3. I have commented my code, particularly in hard-to-understand areas.
  4. Add screenshot it help in review.
  5. Submit your PR by giving the necesarry information in PR template and hang tight we will review it really soon 🚀

Thank you for contributing💗