Merge pull request #21 from Plume-org/org

Organization documents
stable
Baptiste Gelez 5 years ago committed by GitHub
commit 6f2e47a696
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

@ -0,0 +1,56 @@
---
title: Code of Conduct
icon: book-open
summary: 'Our Code of Conduct, based on the Contributor Covenant CoC'
---
Here is Plume's code of conduct. Please read it before contributing, and make sure you understand and accept it.
# Contributor Covenant Code of Conduct
## Our Pledge
In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, sexual identity and orientation, etc.
## 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, 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 both within [project spaces](/organization/where) and in public spaces when an individual is representing the project or its community. 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 project team at moderation@joinplu.me. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
The members of the project team are the people marked as *Member of the moderation team* [on the contributors page](/organization/contributors).
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 [http://contributor-covenant.org/version/1/4][version]
[homepage]: http://contributor-covenant.org
[version]: http://contributor-covenant.org/version/1/4/

@ -0,0 +1,33 @@
---
title: Contributors
summary: 'Who contributes to Plume?'
icon: users
---
# Ana Gelez
**Member of the moderation team**
Preferred pronouns: she/her
Open for mentoring: yes
Accounts:
- GitHub: BaptisteGelez
- Matrix: @baptistegelez:disroot.org
- Fediverse: @Ana@soc.punktrash.club (Pleroma), @Ana@fediverse.blog (Plume)
- Loomio: @anagelez
- Crowdin: AnaGelez
Skills:
- Tech-related: Rust, JavaScript, HTML, CSS/SCSS, Linux
- Languages: French (native), English (not perfect), German (not good), Esperanto (still learning)
# Want to add yourself here?
You can either [do it by yourself](https://github.com/Plume-org/docs/edit/master/source/organization/contributors.html.md)
if you have a GitHub account, or give Ana all the required informations and she will add you (see above for contact information).
Please keep the list alphabetically ordered.

@ -0,0 +1,27 @@
---
title: Organization
icon: calendar
summary: 'Documents that are mostly useful for internal organization'
show_links: yes
---
<h1>How Plume is organized</h1>
<p>These pages are a collection of documents that are mostly useful for internal organization.</p>
<div class="cards">
<% sitemap.resources
.select{ |p| p.path =~ /\.html/ && p.path != "index.html" && p.url.chomp('/').split('/').size == 3 && p.path =~ /organization\// }
.sort{ |a, b| a.data.title <=> b.data.title }
.sort{ |a, b| -(a.data.priority || 0) <=> -(b.data.priority || 0) }
.each do |res|
%>
<article>
<i data-feather="<%= res.data.icon %>"></i>
<h2>
<a href="<%= res.url %>"><%= res.data.title %></a>
</h2>
<p><%= res.data.summary %></p>
</article>
<% end %>
</div>

@ -0,0 +1,43 @@
---
title: Release process
icon: truck
summary: 'What we do between each releases'
---
# Versionning
Plume follows semantic versionning. The 0.x series is for alpha versions. The `x` doesn't actually correspond
to the alpha number, because `0.1.0` was before the first release, and `0.2.0` was the first alpha.
Beta versions or pre-release uses the `-rcX` suffix, where `X` is the number of the release canditate.
Major version changes when API or federation has a breaking change (they should in the same release as much as possible), not when
major changes are made to the interface for example (even if the two are often linked).
# What gets in each version
We don't set deadlines for new releases. We just assign issues (either bug to be fixed or feature requests) on GitHub to a given
milestone as we feel it, and once it is complete, we make a new release.
**[→ Milestones list on GitHub](https://github.com/Plume-org/Plume/milestones?direction=asc&sort=due_date)**
We should prefer making small releases often, than big ones once a year or so.
# The release itself
When we decide to make a new release, we give two weeks to translators to update translations. During this
period bug fixes and new features are accepted, as long as they don't change the messages used in the interface.
At the beginning of the string freeze, the new version of the `.pot` files are uploaded to Crowdin, with all the new
messages that were added during the cycle.
At the end of these two weeks, the updated `.po` get pulled in the main code repository.
We should make sure the documentation is up-to-date before publishing a release.
For each release, we make an announcement as a blog post (on Plume of course), a message on the Matrix room,
and a more technical/impersonal changelog on the GitHub release page (basically a list of the PR that were merged
since the last release). This last technical changelog should include any steps that should be taken for this specific
update that are not listed in the general update documentation.
<!-- TODO: do we need to ping translators when entering string freeze? -->

@ -0,0 +1,49 @@
---
title: Places where Plume is present
icon: share-2
summary: 'Places where you can find Plume online'
---
# GitHub
**[Plume-org on GitHub](https://github.com/Plume-org)**
GitHub is the place where the code lives. The repository for Plume itself is [Plume-org/Plume](https://github.com/Plume-org/Plume).
The source of the [documentation](https://github.com/Plume-org/docs) and the [official website](https://github.com/Plume-org/joinplu.me)
are also hosted here.
GitHub issues are used to list accepted features that should be implemented, or for bug reports. If a feature request needs to be discussed,
a topic should be opened on Loomio first.
# Crowdin
**[Plume on Crowdin](https://crowdin.com/project/plume)**
We use Crowdin to translate Plume's projects.
# Matrix
**[#plume:disroot.org](https://riot.im/app/#/room/#plume:disroot.org)**
Matrix is our main discussion and support channel. We also make announcements about the project here, so you can join it
to stay tuned.
# Loomio (Framavox)
**[Plume's Loomio group](https://framavox.org/g/WK40YHMA/plume)**
Loomio is used to discuss features that need the input of the community before being included (or not).
# Plume
**[~PlumeDev@fediverse.blog](https://fediverse.blog/~/PlumeDev)**
This blog is the one we use to publish news about Plume. All release articles are published here, but
it can also be about technical aspects of the projects, or more general announcements.
# Joining one of these places
We will eventually ask you if you want to be added the GitHib organization, as a Crowdin manager, to the Matrix moderators
or to the authors of *~PlumeDev@fediverse.blog*.
If you consider we should add you, you can also ask by yourselve.
Loading…
Cancel
Save