Skip to content

Contributing to Apizr

We love contributions from everyone! Whether you're reporting bugs, proposing new features, or improving documentation, your help is welcome and appreciated. Below you'll find guidelines to make the contribution process as smooth as possible.

Getting Started

  • Fork the repository on GitHub.
  • Clone your fork to your local machine.
  • Set up the development environment by following the instructions in the README.

Reporting Issues

  • Check the issue tracker to see if the problem has already been reported.
  • If not, create a new issue and provide a clear description of the problem, including steps to reproduce, expected behavior, and actual behavior.

Proposing Enhancements

  • Propose new features and improvements by creating an issue in the issue tracker.
  • Provide a clear description of the enhancement and why it would be valuable to the project.

Submitting Changes

  • Create a new branch for your work.
  • Make your changes following the coding standards and best practices outlined in this document.
  • Write meaningful commit messages that explain your changes.
  • Push your changes to your fork on GitHub.
  • Create a pull request against the main repository, describing your changes and referencing any related issues.

Coding Standards

  • Follow the PEP 8 style guide for Python code.
  • Write clear and concise code with meaningful variable and function names.
  • Add comments and docstrings to explain non-obvious parts of your code.
  • Include unit tests for new code.
  • Ensure all tests pass before submitting a pull request.

Testing

  • Run the test suite to ensure that your changes don't break existing functionality.
  • Add new tests to cover your changes.

Documentation

  • Update the documentation to reflect any changes in functionality or API.
  • Follow the documentation style guide to maintain consistency.

Code of Conduct

By participating in this project, you agree to abide by our Code of Conduct. Please read it to understand our expectations for respectful and collaborative behavior.

Questions?

If you have any questions or need help with your contribution, don't hesitate to reach out through the issue tracker or other community channels.

Thank you for contributing to Apizr!