Contributing to a New Relic Open Source Project
Demonstrating a standard fork-and-pull-request code contribution workflow
For those newer to open source contribution at New Relic, the following points encapsulate the major steps and issues. For command line description of this workflow, consult this documentation.
Step 1: Fork a Repository
Navigate to the repository in GitHub and click the Fork button.
Step 2: Implement changes on your Fork
Now that you have a copy of the repository, implement changes against your forked copy of the code but executing the
clone command, and modify your copy of the code.
Commit message guidance
commit changes to your fork, you want to ensure that your commit messages are human-readable, relevant, descriptive, and follow a standard methodology so that tooling can automate the creation of changelogs.
To support that objective, New Relic open source projects seek to follow the Conventional Commit specification for
git commit messages.
- That your commit messages follow the Convention Commit specification.
- That your commits tie back to a specific Issue in the upstream repository (hint: if there isn't an issue for your change, add it yourself :) ).
Step 3: Initiate a Pull Request
Once you've committed your changes to your fork, you can now issue a Pull Request back to the New Relic project.
Step 4: Accept the New Relic CLA (Contributor License Agreement)
Finally, if you've not contributed to a New Relic open source project before, we're going to prompt you to electronically sign our Contributor License Agreement (CLA), highlighting that you're freely providing code for the benefit of the open source project and community.