mirror of
https://github.com/Foundry376/Mailspring.git
synced 2024-09-20 07:16:08 +08:00
Add CoC, Discourse links
This commit is contained in:
Jason C. McDonald
parent
e6c84f3205
commit
edc749153e
170
CODE_OF_CONDUCT.md
Normal file
170
CODE_OF_CONDUCT.md
Normal file
|
|
@ -0,0 +1,170 @@
|
|||
# Code of Conduct
|
||||
|
||||
Please note that this project is released with a Contributor Code of Conduct.
|
||||
By participating in this project you agree to abide by its terms.
|
||||
|
||||
## Our Pledge
|
||||
|
||||
We as members, contributors, and leaders pledge to make participation in our
|
||||
community a harassment-free experience for everyone, regardless of age, body
|
||||
size, visible or invisible 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.
|
||||
|
||||
We pledge to act and interact in ways that contribute to an open, welcoming,
|
||||
diverse, inclusive, and healthy community.
|
||||
|
||||
## Our Standards
|
||||
|
||||
Examples of behavior that contributes to a positive environment for our
|
||||
community include:
|
||||
|
||||
* Demonstrating empathy and kindness toward other people
|
||||
* Being respectful of differing opinions, viewpoints, and experiences
|
||||
* Giving and gracefully accepting constructive feedback
|
||||
* Accepting responsibility and apologizing to those affected by our mistakes,
|
||||
and learning from the experience
|
||||
* Focusing on what is best not just for us as individuals, but for the
|
||||
overall community
|
||||
|
||||
Examples of unacceptable behavior include:
|
||||
|
||||
* The use of sexualized language or imagery, and sexual attention or
|
||||
advances of any kind
|
||||
* Trolling, insulting or derogatory comments, and personal or political attacks
|
||||
* Public or private harassment
|
||||
* Publishing others' private information, such as a physical or email
|
||||
address, without their explicit permission
|
||||
* Other conduct which could reasonably be considered inappropriate in a
|
||||
professional setting
|
||||
|
||||
## Content Policy
|
||||
|
||||
So we can spend more time discussing and less time cleaning, please make an
|
||||
effort to contribute quality content.
|
||||
|
||||
Please make a good-faith effort to add value to the conversation. Get to know
|
||||
the categories and tags, and use them as appropriate for your content to the
|
||||
best of your ability. Reply to existing threads about a given topic where
|
||||
possible, rather than starting duplicate conversations.
|
||||
|
||||
* Use the like button rather than only posting something like "+1" or "Agreed".
|
||||
* Don't cross-post the same essential thing in multiple topics.
|
||||
* Don't divert a topic by changing it midstream.
|
||||
* Don't post anything that belongs to someone else without permission.
|
||||
* Don't post descriptions of, links to, or methods for stealing someone's
|
||||
intellectual property (software, video, audio, images), or for breaking any
|
||||
other law.
|
||||
* Don't sign your posts — every post has your profile information attached to.
|
||||
* Remember to *debate ideas, never people.*
|
||||
* Don't "bump" conversations or tag individuals/groups with the sole purposes
|
||||
of speeding up response times.
|
||||
|
||||
Additionally, **no spam**. Do not post any content which is intended primarily
|
||||
for promotional purposes or creating backlinks. The one exception to this rule
|
||||
is promoting Mailspring plugins and themes, in the appropriate dedicated
|
||||
category, or in response to a question, issue, or feature request as
|
||||
appropriate.
|
||||
|
||||
## Enforcement Responsibilities
|
||||
|
||||
Everyone is responsible for flagging and reporting violations of this Code of Conduct.
|
||||
Community members are strongly encouraged to report violations rather than
|
||||
engaging with violators by replying.
|
||||
|
||||
Community leaders are responsible for clarifying and enforcing our standards of
|
||||
acceptable behavior and will take appropriate and fair corrective action in
|
||||
response to any behavior that they deem inappropriate, threatening, offensive,
|
||||
or harmful.
|
||||
|
||||
Community leaders 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, and will communicate reasons for moderation
|
||||
decisions when appropriate.
|
||||
|
||||
## Scope
|
||||
|
||||
This Code of Conduct applies within all community spaces, and also applies when
|
||||
an individual is officially representing the community in public spaces.
|
||||
Examples of representing our community include using an official e-mail address,
|
||||
posting via an official social media account, or acting as an appointed
|
||||
representative at an online or offline event.
|
||||
|
||||
## Enforcement
|
||||
|
||||
Instances of abusive, harassing, or otherwise unacceptable behavior may be
|
||||
reported to the community leaders responsible for enforcement either through
|
||||
the flag feature on our Discourse, or by sending an email to
|
||||
`conduct@getmailspring.com`. All complaints will be reviewed and investigated
|
||||
promptly and fairly.
|
||||
|
||||
All community leaders are obligated to respect the privacy and security of the
|
||||
reporter of any incident.
|
||||
|
||||
## Enforcement Guidelines
|
||||
|
||||
Community leaders will follow these Community Impact Guidelines in determining
|
||||
the consequences for any action they deem in violation of this Code of Conduct:
|
||||
|
||||
### 1. Correction
|
||||
|
||||
**Community Impact**: Use of inappropriate language or other behavior deemed
|
||||
unprofessional or unwelcome in the community.
|
||||
|
||||
**Consequence**: A private, written warning from community leaders, providing
|
||||
clarity around the nature of the violation and an explanation of why the
|
||||
behavior was inappropriate. A public apology may be requested.
|
||||
|
||||
### 2. Warning
|
||||
|
||||
**Community Impact**: A violation through a single incident or series
|
||||
of actions.
|
||||
|
||||
**Consequence**: A warning with consequences for continued behavior. No
|
||||
interaction with the people involved, including unsolicited interaction with
|
||||
those enforcing the Code of Conduct, for a specified period of time. This
|
||||
includes avoiding interactions in community spaces as well as external channels
|
||||
like social media. Violating these terms may lead to a temporary or
|
||||
permanent ban.
|
||||
|
||||
### 3. Temporary Ban
|
||||
|
||||
**Community Impact**: A serious violation of community standards, including
|
||||
sustained inappropriate behavior.
|
||||
|
||||
**Consequence**: A temporary ban from any sort of interaction or public
|
||||
communication with the community for a specified period of time. No public or
|
||||
private interaction with the people involved, including unsolicited interaction
|
||||
with those enforcing the Code of Conduct, is allowed during this period.
|
||||
Violating these terms may lead to a permanent ban.
|
||||
|
||||
### 4. Permanent Ban
|
||||
|
||||
**Community Impact**: Demonstrating a pattern of violation of community
|
||||
standards, including sustained inappropriate behavior, harassment of an
|
||||
individual, or aggression toward or disparagement of classes of individuals.
|
||||
|
||||
**Consequence**: A permanent ban from any sort of public interaction within
|
||||
the community.
|
||||
|
||||
## Attribution
|
||||
|
||||
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
|
||||
version 2.0, available at
|
||||
[https://www.contributor-covenant.org/version/2/0/code_of_conduct.html][v2.0].
|
||||
|
||||
The Content Policy is inspired by the [Discourse FAQ](https://meta.discourse.org/faq).
|
||||
|
||||
Community Impact Guidelines were inspired by
|
||||
[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
|
||||
|
||||
For answers to common questions about this code of conduct, see the FAQ at
|
||||
[https://www.contributor-covenant.org/faq][FAQ]. Translations are available
|
||||
at [https://www.contributor-covenant.org/translations][translations].
|
||||
|
||||
[homepage]: https://www.contributor-covenant.org
|
||||
[v2.0]: https://www.contributor-covenant.org/version/2/0/code_of_conduct.html
|
||||
[Mozilla CoC]: https://github.com/mozilla/diversity
|
||||
[FAQ]: https://www.contributor-covenant.org/faq
|
||||
[translations]: https://www.contributor-covenant.org/translations
|
||||
|
|
@ -8,7 +8,13 @@ Thanks for checking out Mailspring! We'd love for you to contribute. Whether you
|
|||
|
||||
### Filing an Issue
|
||||
|
||||
If you have a feature request or bug to report, _please_ search for existing issues **including closed ones!**: https://github.com/Foundry376/Mailspring/issues?utf8=%E2%9C%93&q=is%3Aissue. If someone has already requested the feature you have in mind, upvote it using the "Add Reaction" feature - our team often sorts issues to find the most upvoted ones. For bugs, please verify that you're running the latest version of Mailspring. If you file an issue without providing detail, we may close it without comment.
|
||||
If you have a bug to report or a feature to suggest, you may do so on our [Discourse](https://community.getmailspring.com/). Please carefully follow all instructions in the template for the given type of
|
||||
issue you're reporting.
|
||||
|
||||
We also ask that you search for existing issues, *including closed ones!* We're in the process of migrating
|
||||
our issues to [Discourse](https://community.getmailspring.com/). If someone has already requested the feature you have in mind, upvote it using the "Add Reaction" feature - our team often looks for issues that have community support.
|
||||
|
||||
For bugs, please verify that you're running the latest version of Mailspring. If you file an issue without providing detail, we may close it without comment.
|
||||
|
||||
### Pull requests
|
||||
|
||||
|
|
@ -81,6 +87,10 @@ Back in 2015 and 2016, the Nylas Mail team made a huge effort to document the co
|
|||
|
||||
In order to keep the conversation clear and transparent, please limit discussion to English and keep things on topic with the issue. Be considerate to others and try to be courteous and professional at all times.
|
||||
|
||||
Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.
|
||||
|
||||
[](code_of_conduct.md)
|
||||
|
||||
#### Testing Localization
|
||||
|
||||
You can run the app in different localizations by passing a langauge code to Electron via `--lang=de`. To use this in conjunction `npm start`, you'll need to use the `--` argument forwarding syntax: `npm start -- --lang=de`.
|
||||
|
|
|
|||
18
README.md
18
README.md
|
|
@ -2,7 +2,6 @@
|
|||
|
||||
[](https://travis-ci.org/Foundry376/Mailspring)
|
||||
[](https://ci.appveyor.com/project/Foundry376/Mailspring)
|
||||
[](https://join-mailspring-slack.herokuapp.com/)
|
||||
|
||||
**Mailspring is a new version of Nylas Mail maintained by one of the original authors. It's faster, leaner, and shipping today!** It replaces the JavaScript sync code in Nylas Mail with a new C++ sync engine based on [Mailcore2](https://github.com/MailCore/mailcore2). It uses roughly half the RAM and CPU of Nylas Mail and idles with almost zero "CPU Wakes", which translates to great battery life. It also has an entirely revamped composer and other great new features.
|
||||
|
||||
|
|
@ -20,12 +19,19 @@ Mailspring comes packed with powerful features like Unified Inbox, Snooze, Send
|
|||
|
||||
You can download compiled versions of Mailspring for Windows, Mac OS X, and Linux (deb, rpm and snap) from [https://getmailspring.com/download](https://getmailspring.com/download).
|
||||
|
||||
## Getting Help
|
||||
|
||||
You can find community-based help and discussion with other Mailspring users on our
|
||||
[Discourse community](https://community.getmailspring.com/).
|
||||
|
||||
## Contributing
|
||||
|
||||
Mailspring's UI is entirely open-source and pull requests and contributions are welcome! There are three ways to contribute: building a plugin, building a theme, and submitting pull requests to the project itself. When you're getting started, you may want to join our [public slack](https://join-mailspring-slack.herokuapp.com/) so you can ask questions and learn from other people doing development.
|
||||
Mailspring's UI is entirely open-source and pull requests and contributions are welcome! There are three ways to contribute: building a plugin, building a theme, and submitting pull requests to the project itself. When you're getting started, you may want to join our [Discourse](https://community.getmailspring.com/) so you can ask questions and learn from other people doing development.
|
||||
|
||||
Mailspring's MailSync, however, is closed source. You can read more about the reasons why this is in the [roadmap](https://github.com/Foundry376/Mailspring/blob/master/ROADMAP.md#why-is-mailsync-closed-source).
|
||||
|
||||
[](code_of_conduct.md)
|
||||
|
||||
### Building A Plugin
|
||||
|
||||
Plugins lie at the heart of Mailspring and give it its powerful features. Building your own plugins allows you to integrate the app with other tools, experiment with new workflows, and more. Follow the [Getting Started guide](https://Foundry376.github.io/Mailspring/) to write your first plugin in five minutes.
|
||||
|
|
@ -36,15 +42,21 @@ Plugins lie at the heart of Mailspring and give it its powerful features. Buildi
|
|||
|
||||
A plugin "store" like the Chrome Web Store is coming soon, and will make it easy for other users to discover plugins you create. (Right now, users need to "sideload" the plugins into the app by downloading them and copying them into place.)
|
||||
|
||||
You can share and browse Mailspring Plugins, and discuss plugin development with other developers, on our
|
||||
[Discourse](https://community.getmailspring.com/).
|
||||
|
||||
### Building a Theme
|
||||
|
||||
The Mailspring user interface is styled using CSS, which means it's easy to modify and extend. Mailspring comes stock with a few beautiful themes, and there are many more which have been built by community developers. To start creating a theme, [clone the theme starter](https://github.com/Foundry376/Mailspring-Theme-Starter)!
|
||||
|
||||
If you are updating an existing Nylas theme for Mailspring here is a [step by step tutorial](https://foundry376.zendesk.com/hc/en-us/articles/115001918391-How-do-I-update-an-N1-Nylas-Mail-theme-for-Mailspring-). Notice: as part of the update process you will probably need to [import mailspring base variables](https://github.com/Foundry376/Mailspring/issues/326#issuecomment-343757775).
|
||||
|
||||
You can share and browse Mailspring Themes, and discuss theme development with other developers, on our
|
||||
[Discourse](https://community.getmailspring.com/).
|
||||
|
||||
### Localizing / Translating
|
||||
|
||||
Mailspring 1.5.0 and above support localization. If you're a fluent speaker of another language, we'd love your help improving translations. Check out the [LOCALIZATION](https://github.com/Foundry376/Mailspring/blob/master/LOCALIZATION.md) guide for more information.
|
||||
Mailspring 1.5.0 and above support localization. If you're a fluent speaker of another language, we'd love your help improving translations. Check out the [LOCALIZATION](https://github.com/Foundry376/Mailspring/blob/master/LOCALIZATION.md) guide for more information. You can discuss localization and translation with other developers on our [Discourse](https://community.getmailspring.com/).
|
||||
|
||||
### Contributing to Mailspring Core
|
||||
|
||||
|
|
|
|||
Loading…
Reference in a new issue