Thank you for your interest in contributing to the async-graph-data-flow
codebase!
If you would like to add or update a feature in async-graph-data-flow
,
it is recommended that you first file a GitHub issue to discuss your proposed changes
and check their compatibility with the rest of the package before making a pull request.
This page assumes that you have already created a fork of the async-graph-data-flow
repository under your GitHub account and
have the codebase available locally for development work. If you have followed
these steps,
then you are all set.
The development steps below assume that your local Git repo has a remote
upstream
link to civisanalytics/async-graph-data-flow
:
git remote add upstream https://github.com/civisanalytics/async-graph-data-flow.git
After this step (which you only have to do once),
running git remote -v
should show your local Git repo
has links to both "origin" (pointing to your fork <your-github-username>/async-graph-data-flow
)
and "upstream" (pointing to civisanalytics/async-graph-data-flow
).
To work on a feature or bug fix:
-
Before doing any work, check out the main branch and make sure that your local main branch is up-to-date with upstream main:
git checkout main git pull upstream main
-
Create a new branch. This branch is where you will make commits of your work. (As a best practice, never make commits while on a
main
branch. Runninggit branch
tells you which branch you are on.)git checkout -b new-branch-name
-
Make as many commits as needed for your work.
-
When you feel your work is ready for a pull request, push your branch to your fork.
git push origin new-branch-name
-
Go to your fork
https://github.com/<your-github-username>/async-graph-data-flow
and create a pull request off of your branch against thecivisanalytics/async-graph-data-flow
repo.
The async-graph-data-flow
repo has continuous integration (CI) turned on,
with autobuilds running pytest
(for the test suite in tests/
)
as well as black
and flake8
for consistent code styling.
If an autobuild at an open pull request fails,
then the errors must be fixed by further commits pushed to the branch
by the author before merging is possible.
Work in progress is more than welcome. If you aren't sure how to, say, add tests to go with your proposed changes, please still feel free to create a pull request. We will guide you to polish up your pull request.
If you would like to help avoid wasting free Internet resources (every push of new commits to an open pull request triggers new CI builds), you can run pytest/flake8/black checks locally before pushing commits:
flake8 src tests examples
black --check src tests examples
pytest