Skip to content

Commit

Permalink
docs: add code of conduct and contributing documentation (#671)
Browse files Browse the repository at this point in the history
* docs: add code of conduct and contributing documentation

fix: duplicate source materials entry in contributing.md

docs: add preliminary content to code of conduct

dx: add .nvmrc file (#672)

docs: add build and test steps to contributing.md

docs: add issue template

docs: fix linter error for issue template

docs: add docs for making documentation contributions

docs: add link to rfcs repository in contributing.md

docs: update readme and remove roadmap in favor of lux-rfcs repo

style: whitespace change in contributing.md

docs: left align column 2 of the commit style table in contributing.md

docs: missing punctuation in code of conduct

dx: add .nvmrc file (#672)

docs: change irc to gitter in code of conduct

* docs: use lux+moderators@postlight.com instead of lux@postlight.com

* docs: copy changes in code of conduct

docs: copy changes in code of conduct

* docs: typo in contribting.md

* docs: copy changes in contributing.md

* docs: add instructions for reporting security vulnerabilities

* docs: add a link to flow documentation in contributing.md

* docs: typo in contributing.md

* docs: add webstorm flow docs to contributing.md

* docs: remove unecessary "that" in contributing.md

* docs: widen the scope of the second bullet in the code of conduct

* docs: add pull request template

* docs: add "ways to contribute" section to contributing.md
  • Loading branch information
zacharygolba authored Mar 21, 2017
1 parent 61bb4f4 commit 608409d
Show file tree
Hide file tree
Showing 6 changed files with 412 additions and 179 deletions.
23 changes: 23 additions & 0 deletions .github/ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
<!--
Thanks for reporting an issue!
This issue tracker is for bugs and issues found within Lux core. If you require
more general support please ask in the Gitter room http://bit.ly/2k4qS1k.
Please fill in as much of the template below as you're able.
Platform: output of `uname -a` (UNIX), or version and 32 or 64-bit (Windows)
Database: the RDBMS you are using (i.e SQLite3, MySQL, Postgres, etc.)
Lux Version: the specified version in your `package.json` file
Node Version: output of `node --version`
If possible, please provide a stack trace and/or code that demonstrates the
problem, keeping it as simple and free of external dependencies as you are able.
-->

* **Platform**:
* **Database**:
* **Lux Version**:
* **Node Version**:

<!-- Enter your issue details below this comment. -->
8 changes: 8 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
<!--
Thanks for submitting a pull request!
In order to get this change merged in a timely manner, please provide a short
description, review requirements, and a link to the issue or RFC this addresses.
Contributing Guide: https://github.com/postlight/lux/blob/master/CONTRIBUTING.md
-->
96 changes: 96 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,96 @@
# The Lux Code of Conduct

## Conduct

**Contact Lux moderators:**: [lux+moderators@postlight.com](mailto:lux+moderators@postlight.com)

* We are committed to providing a friendly, safe and welcoming environment for
all, regardless of level of experience, gender, gender identity and expression,
sexual orientation, disability, personal appearance, body size, race, ethnicity,
age, religion, nationality, or other similar characteristic.

* Please avoid avoid using racist, sexually explicit or otherwise hostile
nicknames that might detract from a friendly, safe and welcoming environment for
all.

* Please be kind and courteous. There's no need to be mean or rude.

* Respect that people have differences of opinion and that every design or
implementation choice carries a trade-off and numerous costs. There is seldom a
right answer.

* Please keep unstructured critique to a minimum. If you have solid ideas you
want to experiment with, make a fork and see how it works.

* We will exclude you from interaction if you insult, demean or harass anyone.
That is not welcome behavior. We interpret the term "harassment" as including
the definition in the [Citizen Code of Conduct](http://bit.ly/2jCvEok); if you
have any lack of clarity about what might be included in that concept, please
read their definition. In particular, we don't tolerate behavior that excludes
people in socially marginalized groups.

* Private harassment is also unacceptable. No matter who you are, if you feel
you have been or are being harassed or made uncomfortable by a community member,
please contact one of the channel ops or any of the [Lux moderation team](mailto:lux+moderators@postlight.com)
immediately. Whether you're a regular contributor or a newcomer, we care about
making this community a safe place for you and we've got your back.

* Likewise any spamming, trolling, flaming, baiting or other attention-stealing
behavior is not welcome.

## Moderation

These are the policies for upholding our community's standards of conduct. If you
feel that a thread needs moderation, please contact the [Lux moderation team](mailto:lux+moderators@postlight.com).

1. Remarks that violate the Lux standards of conduct, including hateful, hurtful,
oppressive, or exclusionary remarks, are not allowed. (Cursing is allowed, but
never targeting another user, and never in a hateful manner.)

2. Remarks that moderators find inappropriate, whether listed in the code of
conduct or not, are also not allowed.

3. Moderators will first respond to such remarks with a warning.

4. If the warning is unheeded, the user will be "kicked," i.e., kicked out of
the communication channel to cool off.

5. If the user comes back and continues to make trouble, they will be banned,
i.e., indefinitely excluded.

6. Moderators may choose at their discretion to un-ban the user if it was a first
offense and they offer the offended party a genuine apology.

7. If a moderator bans someone and you think it was unjustified, please take it
up with that moderator, or with a different moderator, **in private**. Complaints
about bans in-channel are not allowed.

8. Moderators are held to a higher standard than other community members. If a
moderator creates an inappropriate situation, they should expect less leeway than
others.

In the Lux community we strive to go the extra step to look out for each other.
Don't just aim to be technically unimpeachable, try to be your best self. In
particular, avoid flirting with offensive or sensitive issues, particularly if
they're off-topic; this all too often leads to unnecessary fights, hurt feelings,
and damaged trust; worse, it can drive people away from the community entirely.

If someone takes issue with something you said or did, resist the urge to be
defensive. Just stop doing what it was they complained about and apologize. Even
if you feel you were misinterpreted or unfairly accused, chances are good there
was something you could've communicated better — remember that it's your responsibility
to make your fellow community members comfortable. Everyone wants to get along and we
are all here first and foremost because we want to talk about cool technology.
You will find that people will be eager to assume good intent and forgive as long
as you earn their trust.

The enforcement policies listed above apply to all official Lux venues; including
the official Gitter room ([*postlight/lux*](http://bit.ly/2k4qS1k)); GitHub
repositories under postlight/lux such as Lux core and other Postlight repositories
with a \*-lux or lux-\* naming convention; For other projects adopting the Lux
Code of Conduct, please contact the maintainers of those projects for enforcement.
If you wish to use this code of conduct for your own project, consider explicitly
mentioning your moderation policy or making a copy with your own moderation policy
so as to avoid confusion.

*Adapted from the [Rust Code of Conduct](https://bit.ly/2jhrmEo).*
Loading

0 comments on commit 608409d

Please sign in to comment.