Skip to content

Latest commit

 

History

History
62 lines (46 loc) · 2.34 KB

CONTRIBUTING.md

File metadata and controls

62 lines (46 loc) · 2.34 KB

Triton Contribution Guidelines

Thanks for using SmartOS and for considering contributing to it!

Code

All changes to Triton project repositories go through code review via a GitHub pull request.

If you're making a substantial change, you probably want to contact developers on the mailing list or IRC first. If you have any trouble with the contribution process, please feel free to contact developers on the mailing list or IRC. Note that larger Triton project changes are typically designed and discussed via "Requests for Discussion (RFDs)".

SmartOS repositories use the Triton Engineering Guidelines. Notably:

  • The #master or #main branch should be first-customer-ship (FCS) quality at all times. Don't push anything until it's tested.
  • All repositories should be "make check" clean at all times.
  • All repositories should have tests that run cleanly at all times.

Issues

There are two separate issue trackers that are relevant for SmartOS code:

Before Triton was open sourced, Joyent engineering used a private JIRA instance. While we continue to use JIRA internally, we also use GitHub issues for tracking -- primarily to allow interaction with those without access to JIRA.

Code of Conduct

All persons and/or organizations contributing to, or intercting with our repositories or communities are required to abide by the illumos Code of Conduct.