Skip to content

Latest commit

 

History

History
50 lines (31 loc) · 2.87 KB

CONTRIBUTING.md

File metadata and controls

50 lines (31 loc) · 2.87 KB

Contributing to DweshaMukt

First off, thank you for considering contributing to DweshaMukt! It's people like you who make this project great. Following these guidelines helps to communicate that you respect the time of the developers managing this project and ensures that contributions are meaningful and effective.

Code of Conduct

This project and everyone participating in it are governed by the DweshaMukt Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to [email protected].

How Can I Contribute?

Reporting Bugs

If you find a bug, please create an issue on GitHub. Provide as much detail as possible, including:

  • A clear description of the problem
  • Steps to reproduce the issue
  • Any error messages or logs
  • Your environment details (e.g., OS, Python version)

Suggesting Enhancements

If you have ideas for new features or improvements, feel free to open an issue with the "enhancement" label. Provide a clear and concise description of the proposed enhancement and how it benefits the project.

Submitting Changes

  1. Fork the Repository: Start by forking the DweshaMukt repository to your GitHub account.
  2. Create a Branch: Create a new branch for your work (use a descriptive name for your branch, e.g., feature/add-new-api).
  3. Make Changes: Commit your changes, ensuring your code adheres to the project's coding standards.
  4. Submit a Pull Request: Once you're satisfied with your changes, submit a pull request to the main repository. Please ensure your pull request includes a clear description of the changes and references any related issues.

Contributor License Agreement (CLA)

Before we can accept your contributions, you’ll need to agree to our Contributor License Agreement (CLA). This ensures that you retain the copyright to your contributions while granting us the right to distribute them under the project's license. You can find the CLA here.

By submitting a contribution, you agree that your contribution is licensed under the same license as the DweshaMukt project (Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International).

Coding Standards

Please ensure your code follows the project’s coding standards:

  • Follow Python PEP 8 guidelines.
  • Include comments and docstrings where necessary.
  • Write meaningful commit messages.
  • Ensure your changes pass existing tests and add new tests as appropriate.

Need Help?

If you have any questions or need help, feel free to reach out by creating an issue on GitHub or by contacting us at [email protected].

Thank You!

Thank you for considering contributing to DweshaMukt! Your contributions are highly appreciated.