Want to contribute to appsignal-javascript? That's great! Here are a few guidelines that will help you contribute. Before we get started: Please note that this project is released with a Contributor Code of Conduct to ensure that this project is a welcoming place for everyone to contribute to. By participating in this project you agree to abide by its terms.
- Contribution workflow
- Guidelines for adding new components
- Contributing to an existing issue
- Our labels
- Create a branch. We use
[git flow](https://github.com/nvie/gitflow)to create branches based ondevelop. - Make your change or bug fix. Don't forget to add yourself to
.all-contributorsrcto show up in our contributors list! - Send a merge request.
- The team will vote using 👍 and 👎
- If approved, a maintainer will merge your change.
You can view the list of issues here. The issues are labelled, so you can use the labels to get an idea of which issue could be a good fit for you. (Here's a good article on how to find your first bug to fix).
Before getting to work, take a look at the issue and at the conversation around it. Has someone already offered to work on the issue? Has someone been assigned to the issue? If so, you might want to check with them to see whether they're still actively working on it.
If the issue is a few months old, it might be a good idea to write a short comment to double-check that the issue or feature is still a valid one to jump on.
Feel free to ask for more detail on what is expected: are there any more details or specifications you need to know?
And if at any point you get stuck: don't hesitate to ask for help.
We've outlined the contribution workflow here. If you're a first-timer, don't worry! GitLab has a ton of guides to help you through your first pull request: You can find out more about pull requests here and about creating a pull request here.
@TODO: document labels.