Skip to content

Latest commit

 

History

History
25 lines (19 loc) · 1.66 KB

contribute.md

File metadata and controls

25 lines (19 loc) · 1.66 KB
Raw

What to contribute

There are many ways that you can contribute to the uAMQP project:

  • Submit a bug
  • Submit a code fix for a bug
  • Submit code to add a new platform/language support to the project, or modify existing code
  • Submit additions or modifications to the documentation
  • Submit a feature request

Contributing Code

To contribute code you need to issue a Pull Request against the master branch. All code submissions will be reviewed and tested, and those that meet a high bar for both quality and design/roadmap appropriateness will be merged into the source.

You must sign a Contribution License Agreement (CLA) before submitting a Pull Request. To complete the CLA, you will need to submit the request via the form and then electronically sign the CLA when you receive the email containing the link to the document.

Big contributions

If your contribution is significantly big it is better to first check with the project developers in order to make sure the change aligns with the long term plans. This can be done simply by submitting a question via the GitHub Issues section.

Things to keep in mind when contributing

Some guidance for when you make a contribution:

  • Add/update the Visio design diagram when required by your change
  • Add/update module requirements as required by your change
  • Add/update unit tests and code as required by your change
  • Make sure you run all the unit tests on the affected platform(s). If the change is in common code, generally running on one platform would be acceptable
  • Run end-to-end tests or simple sample code to make sure the lib works in an end-to-end scenario.