Thank you for your interest in contributing to Ambuda! Ambuda is expanding rapidly, and we're grateful for all the help we can get to complete this ambitious project.
This doc will show you how you can contribute to Ambuda's technical work.
Create a GitHub issues for any technical bugs or issues you see while using Ambuda. Please don't report errors on the text or parse data here.
We use GitHub issues to track our technical work. If there isn't an open issue for what you want to work on, create an issue so that we can discuss it first.
You can claim any issue that doesn't have an open PR or a core team member assigned to it. No need to ask if you can work on it -- just go ahead.
Patch standards:
-
Format your code with
black.On Linux and OS X, you can enable the included pre-commit hook to automate this:
ln -snfr infra/pre-commit .git/hooks/pre-commit
-
Include tests if you're changing code. Your tests should succeed with your patch and fail without it.
-
Update any relevant docs and docstrings.
-
Your PR should contain a single commit that follows the style described here.
-
Fork from Ambuda repo
-
cd ambuda -
Make code changes and commit
-
Submit a PR to development upstream branch
-
Reviewers will respond generally within 24 hours
Our technical documentation will help you build Ambuda on your local machine and run routine development tasks like testing and linting.