Skip to content

Latest commit

 

History

History
75 lines (50 loc) · 3 KB

CONTRIBUTING.md

File metadata and controls

75 lines (50 loc) · 3 KB

Contributing to Kopoze

Thank you for your interest in contributing to Kopoze! We welcome contributions from the community and appreciate your help in making our project better.

Table of Contents

Code of Conduct

We are committed to providing a welcoming and respectful environment for all contributors. Please read and adhere to our Code of Conduct.

How to Contribute

Contributions to Kopoze can be made in several ways:

  • Reporting issues and bugs
  • Suggesting new features or improvements
  • Contributing code and documentation
  • Helping with testing and reviewing pull requests
  • Providing feedback and ideas

Before you start contributing, please review the following guidelines to ensure a smooth and productive process.

Reporting Issues

If you encounter a bug or have a suggestion for improvement, please check our issue tracker to see if it has already been reported. If not, you can open a new issue. When reporting issues, please provide as much detail as possible, including the version of the project you are using, steps to reproduce, and any relevant error messages.

Submitting Pull Requests

If you want to contribute code or documentation, please follow these steps:

  1. Fork the repository to your own GitHub account.
  2. Create a branch from the develop branch with a descriptive name.
  3. Make your changes, adhering to the coding guidelines (see Coding Guidelines).
  4. Write tests for your code if applicable.
  5. Ensure your changes pass all existing tests.
  6. Commit your changes with clear and concise commit messages.
  7. Push your branch to your forked repository.
  8. Create a pull request to the develop branch of the original repository.
  9. Provide a clear title and description for your pull request, including the problem it solves and any relevant information.

A maintainer will review your pull request as soon as possible and may request changes or provide feedback. Once your pull request is approved, it will be merged into the project.

Development Environment Setup

To set up a development environment for Kopoze, follow these steps:

  1. Clone the repository to your local machine:

    git clone https://github.com/kopoze/kpz.git

  2. Install any project-specific dependencies or tools as mentioned in the project documentation.

  3. Run tests to ensure everything is working as expected:

go test ./...

You're ready to start contributing!

License

By contributing to Kopoze, you agree that your contributions will be licensed under the project's LICENSE.

Thank you for contributing to Kopoze!