Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.
You can contribute in many ways:
Types of Contributions¶
Report bugs at bugzilla.
If you are reporting a bug, please include:
Your operating system name and version.
Any details about your local setup that might be helpful in troubleshooting.
Detailed steps to reproduce the bug.
Look through the GitHub issues for bugs. Anything tagged with “bug” and “help wanted” is open to whoever wants to implement it.
Look through the GitHub issues for features. Anything tagged with “enhancement” and “help wanted” is open to whoever wants to implement it.
glean_parser could always use more documentation, whether as part of the
glean_parser docs, in docstrings, or even on the web in blog posts,
articles, and such.
The best way to send feedback is to file an issue at TODO
If you are proposing a feature:
Explain in detail how it would work.
Keep the scope as narrow as possible, to make it easier to implement.
Remember that this is a volunteer-driven project, and that contributions are welcome :)
Ready to contribute? Here’s how to set up
glean_parser for local
glean_parserrepo on GitHub.
Clone your fork locally:
$ git clone firstname.lastname@example.org:your_name_here/glean_parser.git
Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development:
$ mkvirtualenv glean_parser $ cd glean_parser/ $ pip install --editable .
Create a branch for local development:
$ git checkout -b name-of-your-bugfix-or-feature
Now you can make your changes locally.
To test your changes to
Install the testing dependencies:
$ pip install -r requirements_dev.txt
Optionally, if you want to ensure that the generated Kotlin code lints correctly, install a Java SDK, and then run:
$ make install-kotlin-linters
Then make sure that all lints and tests are passing:
$ make lint $ make test
Commit your changes and push your branch to GitHub:
$ git add . $ git commit -m "Your detailed description of your changes." $ git push origin name-of-your-bugfix-or-feature
Submit a pull request through the GitHub website.
Pull Request Guidelines¶
Before you submit a pull request, check that it meets these guidelines:
The pull request should include tests.
If the pull request adds functionality, the docs should be updated. Put your new functionality into a function with a docstring, and describe public-facing features in the docs.
The pull request should work for Python 3.6, 3.7, 3.8 and 3.9 (The CI system will take care of testing all of these Python versions).
The pull request should update the changelog in
To run a subset of tests:
$ py.test tests.test_glean_parser
A reminder for the maintainers on how to deploy.
Get a clean main branch with all of the changes from
$ git checkout main $ git fetch upstream $ git rebase upstream/main
Update the header with the new version and date in
(By using the setuptools-scm package, there is no need to update the version anywhere else).
Make sure all your changes are committed.
Push the changes upstream. (Normally pushing directly without review is frowned upon, but the
mainbranch is protected from force pushes and release tagging requires the same permissions as pushing to
$ git push upstream main
Wait for continuous integration to pass on main.
Make the release on GitHub using this link
Both the tag and the release title should be in the form
Copy and paste the relevant part of the
CHANGELOG.mdfile into the description.
Tagging the release will trigger a CI workflow which will build the distribution of
glean_parserand publish it to PyPI.
The continuous integration system will then automatically deploy to PyPI.