Skip to content

Latest commit

 

History

History
25 lines (18 loc) · 1.86 KB

contributing.md

File metadata and controls

25 lines (18 loc) · 1.86 KB
Raw

Guidelines for Contributors

The Adapter software is open to contributions from the coder community.

The contributors should comply with the University of California Standards of Ethical Conduct.

The contribution can be a bug fix, an improvement to an existing feature, or a fully new feature. If you wish to contribute any of those please follow this workflow:

  1. Fork the Adapter repository.
  2. Create a new issue using the Adapter issue tracker which briefly describes your intended contribution.
  3. Await a response from a person responsible for code maintenance.
  4. Discuss whether there is a need to address this issue and ways in which the issue could be best addressed.
  5. Once an agreement is reached on how to address the issue, develop the code on a new branch on your forked repository. It is highly recommended that the branch includes the Adapter software repo issue number for easier tracking.
  6. When you are happy with your code that addresses the issue, and after you confirm that all tests are passing, create a pull request against the master branch of the Adapter repository.
  7. Notify the person that was discussing the issue with you using @githubname that the feature/fix/improvement is now ready for review.
  8. Conduct iterations of receiving review and addressing it until the reviewer approves the PR.
  9. The reviewer will then thank you and merge the PR.
  10. Now you can start utilizing the updated code!

In addition, if you have questions on how to best apply the existing code for your particular purpose, you may pose those using the Adapter issue tracker.

Thank you for your interest in contributing to our open source Adapter repository!

Milica