How Can I Help?

Are you new to OpenStack or keystone? Are you interested in contributing, but not sure where to start? Here are some easy ways that you can make a difference while you learn the ropes:

  • Read the documentation, starting with the rest of this contributor guide, and try to follow it to set up keystone and try out different features. Does it make sense? Is something out of date? Is something misleading or incorrect? Submit a patch to fix it.

  • Check out the low hanging fruit bugs:

  • Look for deprecation warnings in the unit tests and in the keystone logs of a running keystone installation and submit patches to make them go away.

  • Look at other projects, especially devstack, and submit patches to correct usage of options that keystone has deprecated. Make sure to let the keystone maintainers know you’re looking at these so that it’s on their radar and they can help review.

  • Check the test coverage report (tox -ecover) and try to add unit test coverage.

  • Review new changes. Keep OpenStack’s review guidelines in mind. Ask questions when you don’t understand a change.

Need any help? Reach out to the keystone team.

The Meaning of Low Hanging Fruit

This section describes the intent behind bugs tagged as low hanging fruit. Current maintainers should apply the tag consistently while triaging bugs, using this document as a guide. This practice ensures newcomers to the project can expect each low hanging fruit bug to be of similar complexity.

Bugs fit for the low hanging fruit tag:

  • Should require minimal python experience, someone new to OpenStack might also be new to python

  • Should only require a basic understanding of the review workflow, complicated changesets with dependencies between repositories coupled with CI testing only raises the cognitive bar for new contributors

  • Can include documentation fixes so long it doesn’t require an in-depth understanding of complicated subsystems and features (e.g., overhauling the federated identity guide)

  • Should be something a newcomer can progress through in a week or less, long wait times due to the discussion of complicated topics can deter new contributors from participating

  • Shouldn’t require a new contributor to understand copious amounts of historical context, newcomers should eventually understand this information but consuming that information is outside the scope of low hanging fruit