Hey, we are glad you are interested in contributing to Glean.js!
Contributions are always welcome and they can take many forms: bug reports, documentation changes, feature requests or pull requests.
Before you dive into technical details, take a moment to read our code of conduct. Any form of communication from chat rooms and mailing lists to code comments is expected to follow this code of conduct, so that all can enjoy working on Glean.js.
Glean.js' developer document lives in the docs/
folder in this repository and Glean.js' user documentation lives in The Glean Book.
Here's the guide to get you started!
If you are using Glean.js and found a bug or a missing feature, please file a bug.
Glean.js bugs are filed in Bugzilla. Use this link to file a bug in the Glean SDK Bugzilla component.
As mentioned, Glean.js bugs are filed in Bugzilla. Anything on the Glean SDK component
with the tag [good first bug]
is a good place to start.
These bugs will usually have a comment explaining the steps to get started working on them.
(If you find a [good first bug] that doesn't have an explanation comment, please ask for one).
If you are picking a good first bug or not, make sure you are assigned to the bug before sending a Pull Request for it.
Note When you do send a Pull Request, make sure its title starts
Bug <number of the bug> -, this triggers an action to attach your Pull Request to the Bugzilla bug you are working on.
To contact the Glean team you can:
- Find us in the #glean channel on chat.mozilla.org.
- This is our preferred communication medium.
- Send an email to glean-team@mozilla.com.