-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
97bce91
commit dc2ac0a
Showing
2 changed files
with
291 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,86 @@ | ||
# dahliaOS Code of Conduct | ||
|
||
The dahliaOS team is committed to preserving and fostering a | ||
diverse, welcoming community. Below is our community code of conduct, which | ||
applies to our repos and organizations, issue trackers, Discord servers, | ||
blog content, and any other dahliaOS-supported communication group, as | ||
well as any private communication initiated in the context of these | ||
spaces. This code of conduct must be followed by everyone contributing to | ||
the dahliaOS project, regardless of affiliation or position. | ||
|
||
Simply put, community discussions should be | ||
|
||
* respectful and kind; | ||
* about software; | ||
* about features and code, not the individuals involved. | ||
|
||
## Be respectful and constructive. | ||
|
||
Treat everyone with respect. Build on each other's ideas. Each of us has the | ||
right to enjoy our experience and participate without fear of harassment, | ||
discrimination, or condescension, whether blatant or subtle. Remember that | ||
dahliaOS is a geographically distributed team and that you may not be | ||
communicating with someone in their primary language. We all get frustrated | ||
when working on hard problems, but we cannot allow that frustration to turn | ||
into personal attacks. | ||
|
||
## Speak up if you see or hear something. | ||
|
||
You are empowered to politely engage when you feel that you or others are | ||
disrespected. The person making you feel uncomfortable may not be aware of what | ||
they are doing - politely bringing their behavior to their attention is | ||
encouraged. | ||
|
||
If you are uncomfortable speaking up, or feel that your concerns are not being | ||
duly considered, you can email the Project Integrity team at [email protected] to request involvement from a moderator. All | ||
concerns shared with community managers will be kept confidential, but you may | ||
also submit an anonymous report [here](dahlia-os.github.io/anon). | ||
Please note that without a way to contact you, an anonymous report may be | ||
difficult to act on. You may also create a throwaway account to report. In | ||
cases where a public response is deemed necessary, the identities of victims | ||
and reporters will remain confidential unless those individuals instruct us | ||
otherwise. | ||
|
||
While all reports will be taken seriously, the Project Integrity Team may | ||
not act on complaints that they feel are not violations of this code of | ||
conduct. | ||
|
||
## We will not tolerate harassment of any kind, including but not limited to: | ||
|
||
* Harassing comments | ||
* Intimidation | ||
* Arguing over subjective preference, e.g. text editors, nationality, religion, etc. | ||
* Encouraging a person to engage in self-harm. | ||
* Sustained disruption or derailing of threads, channels, lists, etc. | ||
* Offensive or violent comments, jokes or otherwise | ||
* Inappropriate sexual content | ||
* Unwelcome sexual or otherwise aggressive attention | ||
* Continued one-on-one communication after requests to cease | ||
* Distribution or threat of distribution of people's personally identifying | ||
information, AKA “doxing” | ||
|
||
## Consequences for failing to comply with this policy | ||
|
||
Consequences for failing to comply with this policy may include, at the sole | ||
discretion of the dahliaOS Project Integrity Team: | ||
|
||
* a request for an apology; | ||
* a private or public warning or reprimand; | ||
* a temporary ban from the Discord server, blog, dahlia-os repository or | ||
organization, or other dahliaOS-supported communication group, including | ||
loss of committer status; | ||
* a permanent ban from any of the above, or from all current and future | ||
dahliaOS-supported communities, including loss of | ||
committer status. | ||
|
||
Participants warned to stop any harassing behavior are expected to comply | ||
immediately; failure to do so will result in an escalation of consequences. | ||
|
||
## Acknowledgements | ||
|
||
This Code of Conduct is adapted from the Chromium Project Code of Conduct. | ||
|
||
## License | ||
|
||
This Code of Conduct is available for reuse under the Creative Commons Zero | ||
(CC0) license. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,205 @@ | ||
# Contributing | ||
|
||
First of all, we appreciate you considering contributing to the dahliaOS project! | ||
|
||
To make sure your contributions go as smooth as possible, here's a few tips! | ||
|
||
## Table of contents | ||
|
||
- [Code of Conduct](#code-of-conduct) | ||
- [How can I contribute?](#how-can-i-contribute) | ||
- [Reporting bugs](#reporting-bugs) | ||
- [Before submitting a bug report](#before-submitting-a-bug-report) | ||
- [How do I write a good bug report?](#how-do-i-write-a-good-bug-report) | ||
- [How do I submit a bug report?](#how-do-i-submit-a-bug-report) | ||
- [Feature request](#feature-request) | ||
- [Before submitting a feature request](#before-submitting-a-feature-request) | ||
- [How do I submit a feature request?](#how-do-i-submit-a-feature-request) | ||
- [Translations](#translations) | ||
- [Before making a translation](#before-making-a-translation) | ||
- [How to translate](#how-to-translate) | ||
- [Code contributions](#code-contributions) | ||
- [First code contribution](#first-code-contribution) | ||
- [Design contributions](#design-contributions) | ||
- [Pull requests](#pull-requests) | ||
- [How to make a proper pull request](#how-to-make-a-proper-pull-request) | ||
- [What do I do after I submitted a PR?](#what-do-i-do-after-i-submitted-a-pr) | ||
- [License](#license) | ||
|
||
## Code of Conduct | ||
|
||
dahliaOS' Code of Conduct can be found [here](CODE_OF_CONDUCT.md)! | ||
|
||
This project and everyone participating in it is governed by dahliaOS' Code of Conduct and noone is exempt. | ||
|
||
By participating, you are expected to respect and value this code. | ||
|
||
If you notice any unacceptable behaviour, you can report it to [email protected] | ||
|
||
## How can I contribute? | ||
|
||
Here we've explained we've explained how you can contribute to our project on GitHub but there are also many other ways to help us outside of GitHub, if you'd like to find even more ways to help us, you're always free to join our Discord and ask our team! | ||
|
||
You can contribute to the project by: | ||
|
||
* Reporting a bug | ||
* Proposing new features | ||
* Translating to your native language | ||
* Submitting a fix | ||
* Discussing the current state of code | ||
* Becoming a maintainer | ||
|
||
**Some repositories also have Projects which contain either a to-do list or a roadmap!** | ||
|
||
## Reporting bugs | ||
|
||
If you've experience a bug and you'd like to report it, we highly recommend that you read [Before submitting a bug report](#before-submitting-a-bug-report), [How do I submit a good bug report?](#how-do-i-submit-a-good-bug-report) and that you use our Issue template | ||
|
||
There are 2 ways you can report a bug, either in our Discord by opening a ticket or by creating a GitHub Issue | ||
|
||
### Before submitting a bug report | ||
|
||
Before submitting a bug report, there are a few things you need to take in consideration: | ||
|
||
* Do a bit of research and check if a similar bug has already been reported | ||
* If it has been reported already, add a comment to the existing one instead of submitting a new one | ||
|
||
### How do I write a good bug report? | ||
|
||
We have a few short tips for you on how to properly write a bug report so the developers can understand it better! | ||
|
||
* **Use a clear and descriptive title for the issue** | ||
* **Describe the steps to reproduce the bug** | ||
* **Describe what behaviour you observed after the bug occured** | ||
* **Explain what behaviour you expected to see instead and why** | ||
* **If the problem wasn't triggered by a specific action, describe what you were doing before it happened** | ||
* **Include screnshots of the bug** | ||
* **Write what version of dahliaOS you were using** | ||
|
||
And the most important of all, make sure to fulfill all fields in our Bug report template! | ||
|
||
### How do I submit a bug report? | ||
|
||
* **GitHub**: | ||
* Go to the Issues section | ||
* Click **New issue** | ||
* Select the **Bug report** template | ||
* Fill in the fields | ||
* **Discord**: | ||
* Go to the #bug-report channel | ||
* Open a ticket and copy the form | ||
* Paste and fill in the form | ||
|
||
## Feature request | ||
|
||
If you'd like to see something added to our OS, we highly recommend you read [Before submitting a feature request](#before-submitting-a-feature-request), [How do I submit a feature request?](#how-do-i-submit-a-feature-request) and use our Feature request template | ||
|
||
There are 2 ways you can submit a feature request, either by make a suggestion in our Discord or by creating a Feature request on GitHub | ||
|
||
### Before submitting a feature request | ||
|
||
Before submitting a feature request, here are a few tips for you: | ||
|
||
* **Make sure the feature isn't already added** | ||
* **Don't hesitate to express your knowledge** | ||
* **Write a clear and descriptive title for the request** | ||
* **Explain how the project could benefit of your request** | ||
|
||
### How do I submit a feature request? | ||
|
||
* **GitHub**: | ||
* Go to the Issues section | ||
* Click **New issue** | ||
* Select the **Feature request** template | ||
* Fill in the fields | ||
* **Discord**: | ||
* Go to the #bot-commands channel | ||
* Type !suggestion [suggestion] | ||
|
||
## Translations | ||
|
||
We aim to provide our software in as many languages as possible so everyone could experience it in their own native language! | ||
|
||
For submitting translations, we use Crowdin so please do not edit the files found in the repositories! | ||
|
||
If you're interesting in translating our project, click [this link](https://translate.dahliaos.io)! | ||
|
||
If your language is not added, let us know and we'll add it! | ||
|
||
### Before making a translation | ||
|
||
Before making a translation, please make sure that: | ||
|
||
* **You're fluent in the language you're translating to** | ||
* **You pay close attention to grammar** | ||
* **You read the context (comments) some strings have** | ||
* **You use the same punctuation as the source strings** | ||
|
||
### How to translate | ||
|
||
1. Make a Crowdin account (if you already don't have one) | ||
2. Join our workspace | ||
3. Pick a project to translate (Pangolin, one of the applications etc.) | ||
4. Apply translations to the available strings | ||
|
||
## Code contributions | ||
|
||
To make sure that the code you want to contribute is up to our standards, here we've written a few do's and don'ts! | ||
|
||
**Do:** | ||
|
||
* Choose expressive variable, function and class names, make it as obvious as possible what the code is doing | ||
* The first line of the commit message should have the format "Category: Brief description of what's being changed". The "category" can be a subdirectory, but also something like "POSIX compliance" or "ClassName" | ||
* Split your changes into separate commits | ||
* Write your commit messages in proper English, with care and punctuation | ||
|
||
**Don't:** | ||
|
||
* Submit code that's incompatible with the project licence (Apache 2.0) | ||
* Touch anything outside the stated scope of the PR | ||
* Use weasel-words like "refactor" or "fix" to avoid explaining what's being changed | ||
* Include commented-out code | ||
|
||
### First code contribution | ||
|
||
If you're new to the project, you can look at repositories' Issues section and the issues labeled with the "good first issue" label are perfect for your first code contribution! | ||
|
||
## Design contributions | ||
|
||
Apart from code contributions, we also accept any kind of design contributions! | ||
|
||
**Here are a few repos where you can contribute designs**: | ||
|
||
* [Wallpapers](https://github.com/dahliaos/wallpapers) | ||
* Here you can contribute your own wallpapers, make sure to read the instructions! | ||
* [Icons](https://github.com/dahliaos/icons) | ||
* Here you can contribute either modified version of existing icons or new ones! | ||
* [Brand](https://github.com/dahliaos/brand) | ||
* Here you can contribute new logos or modified current one for our project! | ||
|
||
We also love seeing UI concepts and such designs, you can share any kind of designs in our Discord, feel free to! | ||
|
||
## Pull requests | ||
|
||
PRs to our repositories are always welcome and can be a quick way to get your fix or improvement slated for the next release. In general, PRs should: | ||
|
||
* Fix an existing issue **OR** add a new feature | ||
* Be accompanied by a complete Pull Request template (loaded automatically when a PR is created) | ||
|
||
For changes that address core functionality or would require breaking changes (e.g. a major release), it's best to open an Issue to discuss your proposal first. This is not required but can save time creating and reviewing changes. | ||
|
||
### How to make a proper pull request | ||
|
||
1. Fork the repository to your own Github account | ||
2. Clone the project to your machine | ||
3. Make your changes | ||
4. Push changes to your fork | ||
5. Open a PR in our repository and follow the PR template so that we can efficiently review the changes | ||
|
||
### What do I do after I submitted a PR? | ||
|
||
We kindly ask everyone who has submitted a pull request to be patient and that's really all, we notice every singe new pull request so don't worry about it being ignored | ||
|
||
## License | ||
|
||
By contributing, you agree that your contributions will be licensed under the [Apache 2.0](LICENSE) license |