|
| 1 | +<!-- |
| 2 | + This Source Code Form is subject to the terms of the Mozilla Public |
| 3 | + License, v. 2.0. If a copy of the MPL was not distributed with this |
| 4 | + file, You can obtain one at http://mozilla.org/MPL/2.0/. |
| 5 | +--> |
| 6 | + |
| 7 | +<!-- |
| 8 | + Copyright 2019 Joyent, Inc. |
| 9 | + Copyright 2024 MNX Cloud, Inc. |
| 10 | +--> |
| 11 | + |
| 12 | +# Triton Contribution Guidelines |
| 13 | + |
| 14 | +Thanks for using SmartOS and for considering contributing to it! |
| 15 | + |
| 16 | +## Code |
| 17 | + |
| 18 | +All changes to Triton project repositories go through code review via a GitHub |
| 19 | +pull request. |
| 20 | + |
| 21 | +If you're making a substantial change, you probably want to contact developers |
| 22 | +[on the mailing list or IRC](README.md#community) first. If you have any trouble |
| 23 | +with the contribution process, please feel free to contact developers [on the |
| 24 | +mailing list or IRC](README.md#community). Note that larger Triton project |
| 25 | +changes are typically designed and discussed via ["Requests for Discussion |
| 26 | +(RFDs)"](https://github.com/TritonDataCenter/rfd). |
| 27 | + |
| 28 | +SmartOS repositories use the [Triton Engineering |
| 29 | +Guidelines](https://github.com/TritonDataCenter/eng/blob/master/docs/index.md). |
| 30 | +Notably: |
| 31 | + |
| 32 | +* The #master or #main branch should be first-customer-ship (FCS) quality at all |
| 33 | + times. Don't push anything until it's tested. |
| 34 | +* All repositories should be "make check" clean at all times. |
| 35 | +* All repositories should have tests that run cleanly at all times. |
| 36 | + |
| 37 | +## Issues |
| 38 | + |
| 39 | +There are two separate issue trackers that are relevant for SmartOS code: |
| 40 | + |
| 41 | +* An internal JIRA instance. |
| 42 | + |
| 43 | + A JIRA ticket has an ID like `OS-7260`, where "OS" is the JIRA project |
| 44 | + name -- in this case used by the |
| 45 | + [smartos-live](https://github.com/TritonDataCenter/smartos-live) and related |
| 46 | + repos. A read-only view of most JIRA tickets is made available at |
| 47 | + <https://smartos.org/bugview/> (e.g. |
| 48 | + <https://smartos.org/bugview/OS-7260>). |
| 49 | +* GitHub issues for the relevant repo, e.g. |
| 50 | + <https://github.com/TritonDataCenter/smartos-ui/issues>. |
| 51 | + |
| 52 | +Before Triton was open sourced, Joyent engineering used a private JIRA instance. |
| 53 | +While we continue to use JIRA internally, we also use GitHub issues for |
| 54 | +tracking -- primarily to allow interaction with those without access to JIRA. |
| 55 | + |
| 56 | +## Code of Conduct |
| 57 | + |
| 58 | +All persons and/or organizations contributing to, or intercting with our |
| 59 | +repositories or communities are required to abide by the |
| 60 | +[illumos Code of Conduct][coc]. |
| 61 | + |
| 62 | +[coc]: https://github.com/TritonDataCenter/illumos-joyent/blob/master/CODE_OF_CONDUCT.md |
0 commit comments