Skip to content

Latest commit

 

History

History
68 lines (45 loc) · 3.05 KB

CONTRIBUTING.md

File metadata and controls

68 lines (45 loc) · 3.05 KB
Raw

Contributing to Vedic Sadhana

Thank you for your interest in contributing to the Vedic Sadhana project! We welcome all contributions, whether you're fixing bugs, adding new features, improving documentation, or suggesting ideas. Your input helps make Vedic Sadhana better for everyone.

How to Contribute

1. Star the Repository

Start the Contributing Journey with Staring the Repository Main repository first, which shows your interest in this Project, which also help us to increase our network.

2. Fork the Repository

Start by forking the repository to your GitHub account. This will create your own copy of the project where you can make changes.

3. Clone the Repository

Clone the forked repository to your local machine using the following command:

Use HTTP Method for Cloning

git clone https://github.com/your-username/vedic-sadhana.git

4. Create a New Branch

Create a new branch for your work to keep your changes organized. Use a descriptive name for your branch:

git checkout -b feature/your-feature-name

5. Make Your Changes

Make the necessary changes to the codebase or documentation. Be sure to follow the project's coding standards and best practices.

6. Commit Your Changes

After making your changes, commit them to your branch with a clear and concise commit message:

git add .
git commit -m "Brief description of your changes"

7. Push to Your Fork

Push your changes to your forked repository:

git push origin feature/your-feature-name

8. Submit a Pull Request

Submit a pull request (PR) from your branch to the main branch of the original repository. In your PR description, explain what changes you made and why. Make sure to reference any related issues and make sure to give Image Refernce for the change in your PR description.

9. Review Process

Your pull request will be reviewed by the Project Maintainer. They may ask for changes or provide feedback in term of PR review. Please be responsive and address any comments to get your PR merged.

10. Code of Conduct

Please follow our Code of Conduct in all your interactions with the project.

11. Get in Touch

If you have any questions or need further guidance, feel free to open an issue or reach out to the maintainers.

Contribution Guidelines:

  • Code Style: Follow the existing code style and structure. Consistent and clean code is easier to review and maintain.
  • Testing: Ensure that any new code is tested thoroughly. If possible, add unit tests for new features.
  • Documentation: Update documentation to reflect any changes made, including updating README.md if necessary.
  • Commit Messages: Write clear and concise commit messages. Use the imperative mood ("Add feature X").

Thank you for contributing to Vedic Sadhana and helping make it a better project! If any problem so also refer ReadMe