Skip to content
This repository was archived by the owner on Jan 18, 2025. It is now read-only.

Commit 3425d36

Browse files
committed
chore: reformat
Signed-off-by: Sefa Eyeoglu <[email protected]>
1 parent da9094c commit 3425d36

18 files changed

+1460
-506
lines changed

.github/CODE_OF_CONDUCT.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -14,22 +14,22 @@ appearance, race, religion, or sexual identity and orientation.
1414
Examples of behavior that contributes to creating a positive environment
1515
include:
1616

17-
* Using welcoming and inclusive language
18-
* Being respectful of differing viewpoints and experiences
19-
* Gracefully accepting constructive criticism
20-
* Focusing on what is best for the community
21-
* Showing empathy towards other community members
17+
- Using welcoming and inclusive language
18+
- Being respectful of differing viewpoints and experiences
19+
- Gracefully accepting constructive criticism
20+
- Focusing on what is best for the community
21+
- Showing empathy towards other community members
2222

2323
Examples of unacceptable behavior by participants include:
2424

25-
* The use of sexualized language or imagery and unwelcome sexual attention or
26-
advances
27-
* Trolling, insulting/derogatory comments, and personal or political attacks
28-
* Public or private harassment
29-
* Publishing others' private information, such as a physical or electronic
30-
address, without explicit permission
31-
* Other conduct which could reasonably be considered inappropriate in a
32-
professional setting
25+
- The use of sexualized language or imagery and unwelcome sexual attention or
26+
advances
27+
- Trolling, insulting/derogatory comments, and personal or political attacks
28+
- Public or private harassment
29+
- Publishing others' private information, such as a physical or electronic
30+
address, without explicit permission
31+
- Other conduct which could reasonably be considered inappropriate in a
32+
professional setting
3333

3434
## Our Responsibilities
3535

@@ -70,7 +70,7 @@ members of the project's leadership.
7070
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
7171
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
7272

73-
[homepage]: https://www.contributor-covenant.org
74-
7573
For answers to common questions about this code of conduct, see
7674
https://www.contributor-covenant.org/faq
75+
76+
[homepage]: https://www.contributor-covenant.org

.github/CONTRIBUTING.md

Lines changed: 18 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -11,32 +11,39 @@ We love your input! We want to make contributing to this project as easy and tra
1111
If you are proposing new features, please discuss them with us in the [development server](https://discord.gg/etJNHCQ) before you start working on them!
1212

1313
## We Develop with Github
14+
1415
We use GitHub to host code, to track issues and feature requests, as well as accept pull requests.
1516

1617
## We Use [Git Flow](https://atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow)
17-
![Simple Image Of A Git Flow Workflow](https://nvie.com/img/[email protected])
18-
When contributing to this project, please make sure you follow this and name your branches appropriately!
18+
19+
![Simple Image Of A Git Flow Workflow](https://nvie.com/img/[email protected])\
20+
When contributing to this project, please make sure you follow this and name your branches appropriately!
1921

2022
## All Code Changes Happen Through Pull Requests
21-
Make sure you know how Git Flow works before contributing!
23+
24+
Make sure you know how Git Flow works before contributing!
2225
Pull requests are the best way to propose changes to the codebase. We actively welcome your pull requests:
2326

2427
1. Fork the repo and create your branch from `master` or `development` according to Git Flow.
25-
2. Update the CHANGELOG.
26-
3. If you've changed `core/*` or `bot.py`, mark changelog as "BREAKING" since plugins may break.
27-
4. Make sure your code passes the lint checks.
28-
5. Create Issues and pull requests!
28+
1. Update the CHANGELOG.
29+
1. If you've changed `core/*` or `bot.py`, mark changelog as "BREAKING" since plugins may break.
30+
1. Make sure your code passes the lint checks.
31+
1. Create Issues and pull requests!
2932

3033
## Any contributions you make will be under the GNU Affero General Public License v3.0
34+
3135
In short, when you submit code changes, your submissions are understood to be under the same [GNU Affero General Public License v3.0](https://www.gnu.org/licenses/agpl-3.0.en.html) that covers the project. Feel free to contact the maintainers if that's a concern.
3236

3337
## Report bugs using [Github Issues](https://github.com/modmail-dev/modmail/issues)
38+
3439
We use GitHub issues to track public bugs. Report a bug by [opening a new Issue](https://github.com/modmail-dev/modmail/issues/new); it's that easy!
3540

3641
## Find pre-existing issues to tackle
42+
3743
Check out our [unstaged issue tracker](https://github.com/modmail-dev/modmail/issues?q=is%3Aissue+is%3Aopen+-label%3Astaged) and start helping out!
3844

3945
Ways to help out:
46+
4047
- Help out new members
4148
- Highlight invalid bugs/unsupported use cases
4249
- Code review of pull requests
@@ -45,6 +52,7 @@ Ways to help out:
4552
- Create a pull request to resolve the issue!
4653

4754
## Write bug reports with detail, background, and sample code
55+
4856
**Great Bug Reports** tend to have:
4957

5058
- A quick summary and background
@@ -55,10 +63,13 @@ Ways to help out:
5563
- Notes (possibly including why you think this might be happening, or stuff you tried that didn't work)
5664

5765
## Use a Consistent Coding Style
66+
5867
We use [black](https://github.com/python/black) for a unified code style.
5968

6069
## License
70+
6171
By contributing, you agree that your contributions will be licensed under its MIT License.
6272

6373
## References
74+
6475
This document was adapted from the open-source contribution guidelines for [Facebook's Draft](https://github.com/facebook/draft-js/blob/a9316a723f9e918afde44dea68b5f9f39b7d9b00/CONTRIBUTING.md)

0 commit comments

Comments
 (0)