Skip to content

Latest commit

 

History

History
67 lines (39 loc) · 2.7 KB

CONTRIBUTING.md

File metadata and controls

67 lines (39 loc) · 2.7 KB
Raw

Contributing to BhagavadGita in NextJs

Thank you for considering contributing to the BhagavadGita in NextJs project! Your contributions help improve the project and make it better for everyone.

Project Setup

To set up the project locally, please follow these steps:

  1. Clone the repository: git clone https://github.com/dhruvparmar2310/NextJs-BhagavadGita.git
  2. Install the dependencies: npm install
  3. Build the project: npm run build
  4. Start the development server: npm start

Contribution Guidelines

We welcome contributions from the community. To contribute to the project, please follow these guidelines:

Reporting Issues

If you encounter any bugs, have feature requests, or need assistance, please create a new issue on the issue tracker. When creating an issue, provide as much detail as possible to help us understand and reproduce the problem.

Pull Requests

  1. Fork the repository and create a new branch for your feature or bug fix.
  2. Ensure your code adheres to our coding style and conventions.
  3. Include tests that cover your changes and ensure they pass.
  4. Submit a pull request with a clear description of the changes and any relevant information.

Code Review Process

All contributions go through a code review process. We appreciate your patience during this process. Feedback and suggestions will be provided, and you may need to address them before your changes are merged.

Branching and Versioning

  • Create a new branch for each feature or bug fix, following the naming convention: feature/your-feature-name or bugfix/your-bug-fix-name.
  • We follow Semantic Versioning for versioning. Increment the appropriate version based on the nature of your changes.

Testing

  • Ensure your changes pass the existing tests.
  • Write new tests to cover the changes you've made.

Documentation

  • Maintain clear and concise documentation.
  • Document any new features or significant changes.
  • Keep the documentation up to date with the codebase.

Communication Channels

Join our Slack channel to engage with the community and get support.

Issue Tracking

We use the GitHub issue tracker to track and manage issues. Please create a new issue if you encounter any problems or have questions.

License

This project is licensed under the MIT License.

Code of Conduct

We expect all contributors to adhere to our Code of Conduct. Please be respectful and inclusive.

Contact

If you have any questions or need further assistance, you can reach out to the project maintainers at dhanparmar23@gmail.com.