From 936541f0facde3b9c8db7c1eb8f86524b29cb636 Mon Sep 17 00:00:00 2001 From: Ujjwal Saini <73696489+UjjwalSaini07@users.noreply.github.com> Date: Tue, 13 Aug 2024 19:07:57 +0530 Subject: [PATCH] Create CONTRIBUTING.md --- CONTRIBUTING.md | 66 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 66 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..7a86e3b --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,66 @@ +# 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. 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. + +### 2. Star the Repository +Star the [Main repository](https://github.com/UjjwalSaini07/VedicSadhana), which help to increase our network. + +### 3. Clone the Repository +Clone the forked repository to your local machine using the following command: + +```bash +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: + +```bash +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: + +```bash +git add . +git commit -m "Brief description of your changes" +``` + +### 7. Push to Your Fork +Push your changes to your forked repository: + +```bash +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 maintainers. They may ask for changes or provide feedback. Please be responsive and address any comments to get your PR merged. + +### 10. Code of Conduct +Please follow our [Code of Conduct](https://github.com/UjjwalSaini07/VedicSadhana/blob/main/CODE_OF_CONDUCT.md) 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](https://github.com/UjjwalSaini07/VedicSadhana/blob/main/README.md) +