Skip to content

Latest commit

 

History

History
71 lines (40 loc) · 2.63 KB

CONTRIBUTING.md

File metadata and controls

71 lines (40 loc) · 2.63 KB
Raw

Contributing to ZITA

Thank you for considering contributing to our project! We welcome contributions from the community to make this project even better. Please take a moment to read the following guidelines to ensure a smooth and productive collaboration.

Code of Conduct

Please review and adhere to our Code of Conduct. We expect all contributors to follow these rules and ensure a positive and respectful environment for everyone.

Getting Started

Before you start contributing, make sure you have set up the project locally and understand the basics of how it works.

Reporting Issues

If you find a bug or have a feature request, please open an issue on GitHub. Be sure to include a clear and detailed description of the problem or enhancement you're proposing, along with any relevant information or steps to reproduce the issue.

Pull Requests

We welcome pull requests for bug fixes, enhancements, and new features. To contribute code, follow these steps:

  1. Fork the repository to your GitHub account.

  2. Clone your fork to your local machine:

    git clone https://github.com/your-username/your-project.git

  3. Create a new branch for your changes:

    git checkout -b feature/your-feature-name

  4. Make your changes, commit them, and push to your fork:

    git commit -m "Your detailed commit message"
git push origin feature/your-feature-name

  5. Create a pull request (PR) on the original repository:

    • Provide a clear and concise title and description of your changes.
    • Mention if you'd like feedback or review on your PR.

  6. Be responsive to any feedback or comments on your PR. The maintainers may ask for changes or clarification.

  7. Once your PR is approved, it will be merged into the main project. Congratulations, you've contributed to [Project Name]!

Coding Guidelines

Follow the existing coding style and guidelines in the project. Be consistent with formatting, naming conventions, and code organization.

Testing

Ensure that your code changes are tested, and if applicable, add new tests. Make sure all existing tests pass.

Documentation

If your contribution introduces new features or changes existing functionality, update the project's documentation as necessary.

Code Review

All code changes are subject to review. Be open to feedback and be willing to address any concerns or suggestions from the maintainers or other contributors.

License

By contributing to this project, you agree that your contributions will be licensed under the MIT License.

Thank you for your contribution!