Thank you for your interest in contributing to the Glean Dictionary. This document tries to codify some best practices for contribution to this repository.
All communication (on the Glean Dictionary channel, on mailing lists, and in pull requests and issues) is expected to follow the Mozilla Community Participation Guidelines. For more information, see the code of conduct document in the root of this repository.
File an issue if you have a bug report or feature request that you (personally) do not intend to work on right away or you would like additional feedback on your approach before starting implementation work. If you found a bug (or small missing feature) and you want to start implementing it immediately (or already have a solution), go ahead and skip straight to making a pull request (see below).
To help with triage, issues should have a descriptive title. Examples of good issue titles:
- Storybook doesn't render components with styling
- Add a filter box to the applications page
In the issue itself, provide as much information as necessary to help someone reading it understand the nature of the problem (and provide feedback). For examples of this, look at some of the fixed issues filed by the project maintainers.
Like issues, pull requests should have a descriptive title to help with triage. However there are two things that are different:
- Instead of pointing out a problem, they should describe the solution
- If a pull request fixes a specific issue, the title should specify
(fixes #X)(where X refers to the issue number)
For example, a pull request to fix an issue entitled "Storybook doesn't render components with styling" could be named "Render storybook components with styling (fixes #1234)".
As much as possible, each pull request should attempt to solve one problem. For logically separate changes, file multiple PRs.
Make sure that the pull request passes continuous integration (including linter errors) and that there are no merge conflicts before asking for review. If you want some feedback on a work-in-progress (where these conditions are not yet met), mark your pull request as a draft.