Contributing to Motify¶

We welcome contributions! Here's how to get started:

Setting Up¶

Fork the repo and clone your fork
Install Python 3.10+
Install dependencies:
```
pip install -r requirements.txt
```
(Optional) Set up a virtual environment

Coding Standards¶

Follow PEP8 for Python code
Write clear, concise commit messages
Add docstrings and comments

Submitting Pull Requests¶

Create a new branch for your feature or fix
Ensure all tests pass
Open a pull request with a clear description

Getting Help¶

Open an issue on GitHub
Join our Discord

Development Process¶

We use GitHub to host code, to track issues and feature requests, as well as accept pull requests.

Fork the repo and create your branch from main
If you've added code that should be tested, add tests
If you've changed APIs, update the documentation
Ensure the test suite passes
Make sure your code lints
Issue that pull request!

Pull Request Process¶

Update the README.md with details of changes if needed
Update the docs/ with any new documentation
The PR will be merged once you have the sign-off

Any contributions you make will be under the MIT Software License¶

In short, when you submit code changes, your submissions are understood to be under the same MIT License that covers the project. Feel free to contact the maintainers if that's a concern.

Report bugs using GitHub's [issue tracker]¶

We use GitHub issues to track public bugs. Report a bug by opening a new issue!

Write bug reports with detail, background, and sample code¶

Great Bug Reports tend to have:

A quick summary and/or background
Steps to reproduce
What you expected would happen
What actually happens
Notes (possibly including why you think this might be happening)

Use a Consistent Coding Style¶

4 spaces for indentation rather than tabs
80 character line length
Run pylint over your code

License¶

By contributing, you agree that your contributions will be licensed under its MIT License.