2016-04-10 14:56:46 +00:00
|
|
|
/This document is under construction, the final version will be released in the
|
|
|
|
version 0.106.0 of Spacemacs/
|
|
|
|
|
2016-04-11 02:06:49 +00:00
|
|
|
* Philosophy
|
|
|
|
** For Contributors
|
|
|
|
- This community is a community of hackers based on meritocracy and volunteering.
|
2016-04-12 03:31:28 +00:00
|
|
|
Hackers strive for excellence to make the world a better place, so does the
|
2016-04-12 02:07:41 +00:00
|
|
|
Spacemacs community.
|
2016-04-11 02:06:49 +00:00
|
|
|
- Be good in what you bring to the project be it code, documentation, typo
|
2016-04-12 02:07:41 +00:00
|
|
|
fixes, art, humor, ideas, project management, web design, assurance quality,
|
|
|
|
mentorship, you name it! We like to award achievements to people making a
|
|
|
|
difference in a wide variety of domains and occasions, [[file:./doc/DOCUMENTATION.org#specials][see it for yourself]].
|
|
|
|
Why not you? Make it happen, make history!
|
2016-04-10 04:14:42 +00:00
|
|
|
- Think you are not good enough? Find support and mentors by chatting on Gitter
|
2016-04-12 02:07:41 +00:00
|
|
|
with fellow Spacemacs users or just open an issue on GitHub, you will find
|
|
|
|
help to fulfil your desire of contribution. We welcome anyone with good
|
|
|
|
intentions.
|
2016-04-11 02:06:49 +00:00
|
|
|
- In a nutshell: Be good, positive and/or with good intentions and focused on
|
2016-04-12 02:07:41 +00:00
|
|
|
the project.
|
2016-04-11 02:06:49 +00:00
|
|
|
** For Users
|
|
|
|
- Any question related to the project is welcomed and encouraged, the worst
|
2016-04-12 02:07:41 +00:00
|
|
|
thing that can happen is that we redirect you to the documentation.
|
2016-04-11 02:06:49 +00:00
|
|
|
- The majority of the interactions with the community happens on GitHub via
|
2016-04-12 02:07:41 +00:00
|
|
|
issues and on Gitter via the official Spacemacs channel. There is also an
|
|
|
|
active official twitter account =spacemacs=.
|
2016-04-10 04:14:42 +00:00
|
|
|
- Any opinion on the project is valorized given it is constructive.
|
2016-04-11 02:06:49 +00:00
|
|
|
|
|
|
|
* Moderation
|
|
|
|
We want the community to be judged based on its moderation actions instead of
|
|
|
|
telling people how to behave. The golden rules of the community are to have good
|
|
|
|
intentions and stay focused on the project, for anything else that requires
|
|
|
|
moderation any future user or contributor can refer to this section to know
|
|
|
|
about our past moderation actions. So readers won't find any example or
|
|
|
|
definition of what collaborators judge offending or outrageous, instead they
|
|
|
|
will find at the end of this section a log of all major moderation actions taken
|
|
|
|
by the collaborators since the beginning of the project which started officially
|
|
|
|
in August 2014. It should allow you to decided whether or not you want to be
|
|
|
|
part of this community. If you are not convinced then be assured that the only
|
|
|
|
evil part in Spacemacs is the evil mode :-)
|
|
|
|
** Guidelines
|
|
|
|
These guidelines apply to all collaborators of the project, namely @syl20bnr,
|
|
|
|
@TheBB and @StreakyCobra.
|
|
|
|
*** People
|
|
|
|
- Collaborators cannot ban any GitHub user from the repository but they can ban
|
2016-04-12 02:07:41 +00:00
|
|
|
users from the official Gitter channel.
|
2016-04-11 02:06:49 +00:00
|
|
|
- A user can be banned if and only if all the collaborators agree to do so.
|
|
|
|
- The reasons of the ban are mentioned in the moderation actions log (see below).
|
|
|
|
*** Issues
|
|
|
|
- Issues can be locked if their contents are judged _inappropriate_, _offending_
|
2016-04-12 02:07:41 +00:00
|
|
|
or if they deviate _dangerously_ from the focus which is the project.
|
2016-04-11 02:06:49 +00:00
|
|
|
*** Pull requests and Commmits
|
|
|
|
- Collaborators can push to the repository without making a PR.
|
|
|
|
- PR can be rejected. Rejected PR always go with a reason explicitly written
|
2016-04-12 02:07:41 +00:00
|
|
|
when closing the PR.
|
2016-04-11 02:06:49 +00:00
|
|
|
- Commits can be reverted if they compromise the stability of the project. The
|
2016-04-12 02:07:41 +00:00
|
|
|
reason is contained in the commit comments.
|
2016-04-11 02:06:49 +00:00
|
|
|
- Pull request are also issues, thus issue guidelines also apply to pull
|
2016-04-12 02:07:41 +00:00
|
|
|
requests.
|
2016-04-11 02:06:49 +00:00
|
|
|
*** Messages
|
|
|
|
- Only the form of a message can be edited, not its meaning, except if this
|
2016-04-12 02:07:41 +00:00
|
|
|
meaning is _outrageous_.
|
2016-04-11 02:06:49 +00:00
|
|
|
- Moderators can add information to a message to improve its accuracy without
|
2016-04-12 02:07:41 +00:00
|
|
|
altering its meaning,
|
2016-04-11 02:06:49 +00:00
|
|
|
- Any edition of a message is logged in the =edits log= located at the end of
|
2016-04-12 02:07:41 +00:00
|
|
|
the edited message with the following format:
|
|
|
|
#+BEGIN_EXAMPLE
|
|
|
|
EDIT: [@moderator] action (reason: xxx)
|
|
|
|
#+END_EXAMPLE
|
2016-04-11 02:06:49 +00:00
|
|
|
- The reason is added only when needed (for instance we won't add a reason for
|
2016-04-12 02:07:41 +00:00
|
|
|
formatting edits)
|
2016-04-11 02:06:49 +00:00
|
|
|
** Interpretation
|
|
|
|
Words used in these guidelines like _inappropriate_, _offending_, _dangerously_
|
|
|
|
and _outrageous_ are used without any explanation on purpose, their meanings and
|
|
|
|
interpretations are left solely to the discretion of the collaborators who are
|
|
|
|
educated persons and highly trusted members of the community happy to help it to
|
|
|
|
grow in a sane manner.
|
|
|
|
** Collaborators privacy
|
|
|
|
Life and actions of collaborators outside of the project (i.e. outside of the
|
|
|
|
Spacemacs GitHub repository, official Spacemacs Gitter channels and Twitter
|
|
|
|
official Spacemacs account timeline) are completely detached from their
|
|
|
|
activities and roles in the project. They are free to express any opinion on the
|
|
|
|
project or any other subjects and those opinions cannot be used to compromise
|
|
|
|
their roles in the project as long as they follow the moderation guidelines with
|
|
|
|
good intentions.
|
|
|
|
** Maintainer
|
|
|
|
- The maintainer @syl20bnr as a BDFL is free to demote a collaborator in extreme
|
2016-04-12 02:07:41 +00:00
|
|
|
situations.
|
2016-04-11 02:06:49 +00:00
|
|
|
- When there is no consensus on a subject, the BDFL can decide to impose his
|
2016-04-12 02:07:41 +00:00
|
|
|
view on the subject.
|
2016-04-11 02:06:49 +00:00
|
|
|
** Log
|
|
|
|
For transparency and future reference any major moderation actions are recorded
|
|
|
|
here. As of Sunday, April 10th 2016, 5747 issues have been opened and 2 major
|
|
|
|
moderation actions have been taken:
|
|
|
|
| Date | Moderator | Action | Issue | Reason |
|
|
|
|
|------------+-----------+--------+-------+-----------------------------------------------------------------|
|
|
|
|
| 2016/01/27 | syl20bnr | lock | #3484 | comments judged to be offending towards the Spacemacs community |
|
|
|
|
| 2016/01/27 | syl20bnr | unlock | #3484 | let's make it happen, i.e. this document |
|