diff options
| -rw-r--r-- | CODE_OF_CONDUCT.md | 85 | ||||
| -rw-r--r-- | README | 49 | ||||
| -rw-r--r-- | README.md | 41 |
3 files changed, 126 insertions, 49 deletions
diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000000..9796fb4400 --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,85 @@ +# illumos Project Code of Conduct + +## Our Pledge + +In the interest of fostering an open and welcoming environment, we as +contributors and maintainers pledge to make participation in our project and +our community a harassment-free experience for everyone, regardless of age, +body size, disability, ethnicity, sex characteristics, gender identity and +expression, level of experience, education, socio-economic status, nationality, +personal appearance, race, religion, or sexual identity and orientation. + +## Our Standards + +Examples of behavior that contributes to creating a positive environment +include: + +* Using welcoming and inclusive language +* Being respectful of differing viewpoints and experiences +* Gracefully accepting constructive criticism +* Focusing on what is best for the community +* Showing empathy towards other community members + +Examples of unacceptable behavior by participants include: + +* The use of sexualized language or imagery and unwelcome sexual attention or + advances +* Trolling, insulting/derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or electronic + address, without explicit permission +* Other conduct which could reasonably be considered inappropriate in a + professional setting + +## Our Responsibilities + +Project maintainers are responsible for clarifying the standards of acceptable +behavior and are expected to take appropriate and fair corrective action in +response to any instances of unacceptable behavior. + +Project maintainers have the right and responsibility to remove, edit, or +reject comments, commits, code, wiki edits, issues, mailing list posts, and +other contributions that are not aligned to this Code of Conduct, or to ban +temporarily or permanently any contributor for other behaviors that they deem +inappropriate, threatening, offensive, or harmful. + +## Scope + +This Code of Conduct applies within all project spaces, including but not +limited to: + +* The illumos [bug + tracker](https://www.illumos.org/projects/illumos-gate/issues) +* Code review feedback on the illumos [Review Board](https://illumos.org/rb) +* Project [Mailing Lists and IRC Channels](https://illumos.org/docs/community/) +* GitHub issues and pull requests on [illumos + repositories](https://github.com/illumos) + +The Code of Conduct also applies when an individual is representing the project +or its community in public spaces. Examples of representing a project or +community include using an official project e-mail address, posting via an +official social media account, or acting as an appointed representative at an +online or offline event. Representation of a project may be further defined +and clarified by project maintainers. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported by contacting the moderation team at [conduct@illumos.org][mailto]. +All complaints will be reviewed and investigated and will result in a response +that is deemed necessary and appropriate to the circumstances. The project team +is obligated to maintain confidentiality with regard to the reporter of an +incident. + +Project maintainers who do not follow or enforce the Code of Conduct in good +faith may face temporary or permanent repercussions as determined by other +members of the project's leadership. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], +version 1.4, available at +https://www.contributor-covenant.org/version/1/4/code-of-conduct.html + +[mailto]: mailto:conduct@illumos.org +[homepage]: https://www.contributor-covenant.org diff --git a/README b/README deleted file mode 100644 index 9fd99ad6c8..0000000000 --- a/README +++ /dev/null @@ -1,49 +0,0 @@ -illumos gate README - Sep 16, 2012. - -This is the illumos gate. This is the illumos source tree. It contains -the following subdirectories: - - usr/src - The actual source code - - exception_lists - These are lists of exceptional cases - used to limit noise during builds. - Ideally this directory would consist of - only empty files. - -Integration Rules: - - All changes must have been reviewed, and approved by an advocate - (below). A code review may be performed by someone other than the - advocate, but the final integration should still be approved by the - advocate. - - The advocate will want to see your webrev and hg outgoing -v. The - advocate will also ask about your testing, and may ask to see your - build logs. - - All changes must adhere to typical ON style and quality rules. - For example, pass full cstyle, applicable lint rules, etc. - - All new code must be licensed under CDDL, and modifications to existing - code may not alter the original license terms. Integrations of code - from upstream sources that use another liberal open source license are - permissible, subject to approval of the advocates or developer council. - Exceptions to this policy shall require the approval of the developer - council. - - Commits should have comments of the following form: - - 1234 This is a sample bug report synopsis - 4567 If you have a second bug synopsis… - Reviewed by: Frodo Baggins <frodo.baggins@underhill.net> - Reviewed by: Legolas <elf-coder@mirkwood.org> - Approved by: Gandalf The Grey <rti-advocate@white-council.com> - - Each commit must have at least one bug id that is listed in the - illumos-gate project at www.illumos.org. - -RTI Advocates: advocates@lists.illumos.org -Developer Council: developer-council@lists.illumos.org - -IRC channel: #illumos on irc.freenode.net -Mailing list: developer@lists.illumos.org diff --git a/README.md b/README.md new file mode 100644 index 0000000000..e92b6c179c --- /dev/null +++ b/README.md @@ -0,0 +1,41 @@ +# illumos-gate + +This is the core [illumos](https://illumos.org) source tree. + +## Building + +The illumos build must be run on an illumos-based operating system. See the +[Building illumos](https://illumos.org/docs/developers/build/) section of our +documentation for detailed instructions. + +## Contributing + +Code changes must be reviewed and tested. If you'd like to submit a change for +inclusion in the project, please see the [Contributing to +illumos](https://illumos.org/docs/contributing/) guide in our documentation. + +## Community + +The illumos community is small but active. We welcome everybody who would like +to use the software and participate in the community -- whether you've decades +of experience in systems software, or you're just getting started; whether you +work for a company that uses illumos, or you just find it personally +interesting. + +Our [Community](https://illumos.org/docs/community/) guide includes details +about our Mailing Lists and IRC channels. + +## Code of Conduct + +Participation in our community spaces, and in the project in general, are +covered by our [Code of Conduct](./CODE_OF_CONDUCT.md). By participating in +the project you agree to abide by its terms. + +## License + +Most of the existing code is licensed under the +[CDDL](https://illumos.org/license/CDDL) and we expect new code will generally +be under this license as well. Modifications of existing code may not alter +the original license terms. Integrations of code from upstream sources that +use another open source license are permissible, subject to approval of the +advocates. |