r3w0p/bobocep

# Contributing

> _Last updated: 2023-01-27_


## Resources

Here are some important resources:

- [Documentation](https://bobocep.readthedocs.io/): for learning resources and code index.

- [Issues](https://github.com/r3w0p/bobocep/issues): for contributing bug reports and feature requests.


## Submitting Changes

- Please send a [pull request to BoboCEP](https://github.com/r3w0p/bobocep/compare) using the template provided.
  For more information about pull requests, click [here](https://docs.github.com/en/pull-requests/).

- Always write clear log messages with your commits.

- Add sufficient comments to your code.


### Testing

When testing your code, use the same packages that are provided in the requirement files, namely:

- [requirements.txt](https://github.com/r3w0p/bobocep/blob/main/requirements.txt) for the primary dependencies of the software.

- [requirements-dev.txt](https://github.com/r3w0p/bobocep/blob/main/requirements-dev.txt) for development dependencies: testing, documentation, and so on.


### Coding Conventions

- Use the [PEP 8](https://peps.python.org/pep-0008/) style guide for Python code.
  The [PyCharm](https://www.jetbrains.com/help/pycharm/tutorial-code-quality-assistance-tips-and-tricks.html) 
  IDE can help with this.

- Try to remain consistent with existing code conventions in use.