Contributing to the FreeMoCap Project
Welcome to the FreeMoCap contributing guide!
This document will help you understand how to contribute to the project, whether you're reporting bugs, suggesting new features, or submitting code changes. We're excited to have you on board and look forward to working with you!
Reporting Bugs
Your feedback is invaluable in improving FreeMoCap. In this section, you'll learn how to report bugs and suggest new features for the project.
For details, see our Bug Report guide
Suggesting Features
We welcome your ideas for new features or improvements to FreeMoCap. To suggest a feature, open a new issue and describe the feature, its benefits, and any potential challenges in implementing it.
For details, see our Feature Request guide
Code Contributions
Contributing code to FreeMoCap involves creating and submitting pull requests. In this section, you'll learn about our development process, coding styles, and testing requirements.
We Use GitHub Flow
We use Github Flow as our development process. It makes it easy for contributors to submit changes and maintainers to review and merge them.
Code Changes Happen Through Pull Requests
Pull requests are the best way to propose changes to the codebase (we use Github Flow).
We actively welcome your 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!
Coding Styles
Consistent coding styles are important for maintaining a clean and easy-to-understand codebase. We use the following style guides for our project:
PyQT: [COMING SOON]
API: [COMING SOON]
Testing
We require tests for all code contributions to ensure the stability and reliability of the project. When submitting a pull request, make sure your code is covered by tests, and that those tests pass our Github Actions workflow.
Here's a nice introduction to testing in Python.
Pull Requests
Pull requests are the best way to propose changes to the codebase (we use Github Flow). We actively welcome your 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!
Contributing to Documentation
Our documentation is written with Writerside, although it can be edited with any markdown and xml editors. We use the same Github Flow methodology for our documentation as we do for our code contributions. You can make changes to the documentation through pull requests at the documentation repo.
Getting Help and Asking Questions
If you encounter issues or have questions - ask for help on our Discord server or by creating a new issue on Github. We'll do our best to assist you and provide the information you need.