Skip to content

Commit dba8a57

Browse files
No767No767
authored
Entirely rewrite documentation once again (#225)
* finish rewriting docs * finishh docs
1 parent 00c92b5 commit dba8a57

15 files changed

+396
-957
lines changed

‎.github/CODE_OF_CONDUCT.md

+130
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,130 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
We as members, contributors, and leaders pledge to make participation in our
6+
community a harassment-free experience for everyone, regardless of age, body
7+
size, visible or invisible disability, ethnicity, sex characteristics, gender
8+
identity and expression, level of experience, education, socio-economic status,
9+
nationality, personal appearance, race, religion, or sexual identity
10+
and orientation.
11+
12+
We pledge to act and interact in ways that contribute to an open, welcoming,
13+
diverse, inclusive, and healthy community.
14+
15+
## Our Standards
16+
17+
Examples of behavior that contributes to a positive environment for our
18+
community include:
19+
20+
* Demonstrating empathy and kindness toward other people
21+
* Being respectful of differing opinions, viewpoints, and experiences
22+
* Giving and gracefully accepting constructive feedback
23+
* Accepting responsibility and apologizing to those affected by our mistakes,
24+
and learning from the experience
25+
* Focusing on what is best not just for us as individuals, but for the
26+
overall community
27+
* Using the correct pronouns that someone may identify with
28+
29+
Examples of unacceptable behavior include:
30+
31+
* The use of sexualized language or imagery, and sexual attention or
32+
advances of any kind
33+
* Trolling, insulting or derogatory comments, and personal or political attacks
34+
* Public or private harassment
35+
* Publishing others' private information, such as a physical or email
36+
address, without their explicit permission
37+
* Other conduct which could reasonably be considered inappropriate in a
38+
professional setting
39+
* Being Transphobic, Homophobic, or Misgendering anyone within the community
40+
41+
## Enforcement Responsibilities
42+
43+
Community leaders are responsible for clarifying and enforcing our standards of
44+
acceptable behavior and will take appropriate and fair corrective action in
45+
response to any behavior that they deem inappropriate, threatening, offensive,
46+
or harmful.
47+
48+
Community leaders have the right and responsibility to remove, edit, or reject
49+
comments, commits, code, wiki edits, issues, and other contributions that are
50+
not aligned to this Code of Conduct, and will communicate reasons for moderation
51+
decisions when appropriate.
52+
53+
## Scope
54+
55+
This Code of Conduct applies within all community spaces, and also applies when
56+
an individual is officially representing the community in public spaces.
57+
Examples of representing our community include using an official e-mail address,
58+
posting via an official social media account, or acting as an appointed
59+
representative at an online or offline event.
60+
61+
## Enforcement
62+
63+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
64+
reported to the community leaders responsible for enforcement at
65+
[email protected].
66+
All complaints will be reviewed and investigated promptly and fairly.
67+
68+
All community leaders are obligated to respect the privacy and security of the
69+
reporter of any incident.
70+
71+
## Enforcement Guidelines
72+
73+
Community leaders will follow these Community Impact Guidelines in determining
74+
the consequences for any action they deem in violation of this Code of Conduct:
75+
76+
### 1. Correction
77+
78+
**Community Impact**: Use of inappropriate language or other behavior deemed
79+
unprofessional or unwelcome in the community.
80+
81+
**Consequence**: A private, written warning from community leaders, providing
82+
clarity around the nature of the violation and an explanation of why the
83+
behavior was inappropriate. A public apology may be requested.
84+
85+
### 2. Warning
86+
87+
**Community Impact**: A violation through a single incident or series
88+
of actions.
89+
90+
**Consequence**: A warning with consequences for continued behavior. No
91+
interaction with the people involved, including unsolicited interaction with
92+
those enforcing the Code of Conduct, for a specified period of time. This
93+
includes avoiding interactions in community spaces as well as external channels
94+
like social media. Violating these terms may lead to a temporary or
95+
permanent ban.
96+
97+
### 3. Temporary Ban
98+
99+
**Community Impact**: A serious violation of community standards, including
100+
sustained inappropriate behavior.
101+
102+
**Consequence**: A temporary ban from any sort of interaction or public
103+
communication with the community for a specified period of time. No public or
104+
private interaction with the people involved, including unsolicited interaction
105+
with those enforcing the Code of Conduct, is allowed during this period.
106+
Violating these terms may lead to a permanent ban.
107+
108+
### 4. Permanent Ban
109+
110+
**Community Impact**: Demonstrating a pattern of violation of community
111+
standards, including sustained inappropriate behavior, harassment of an
112+
individual, or aggression toward or disparagement of classes of individuals.
113+
114+
**Consequence**: A permanent ban from any sort of public interaction within
115+
the community.
116+
117+
## Attribution
118+
119+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
120+
version 2.0, available at
121+
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
122+
123+
Community Impact Guidelines were inspired by [Mozilla's code of conduct
124+
enforcement ladder](https://github.com/mozilla/diversity).
125+
126+
[homepage]: https://www.contributor-covenant.org
127+
128+
For answers to common questions about this code of conduct, see the FAQ at
129+
https://www.contributor-covenant.org/faq. Translations are available at
130+
https://www.contributor-covenant.org/translations.

‎.github/CONTRIBUTING.md

+51-2
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,53 @@
11
# Contributing
22

3-
Thank you for your interest in contributing to this project!
4-
The rest of the document can be found [here](https://rodhaj.readthedocs.io/en/latest/dev-guide/contributing.html).
3+
Thank you for your interest in contributing to this project! Your effort really does make the project better.
4+
You will need to read the setup instructions before you start working.
5+
6+
The following is a set of guidelines for contributing to the repository. These are not hard rules.
7+
8+
## I'm confused and want to ask questions!
9+
10+
Generally, there are much better resources that are available. These include:
11+
12+
- The official server: https://discord.gg/GnkYGvcVcH
13+
- FAQ in the documentation
14+
15+
Make sure to not ask questions in the issue tracker.
16+
17+
## Ways You Can Contribute
18+
19+
The ways you can contribute are not only limited to code changes, but so much more.
20+
Some of the ways you can contribute are:
21+
22+
- Reporting a bug
23+
- Discussing the current state and future of the project
24+
- Submitting a fix
25+
- Proposing new features
26+
- Improving or editing documentation
27+
28+
Note that if you plan on proposing new features, please first discuss them with the owner and others on the issues page.
29+
30+
## Writing Good Bug Reports
31+
32+
Please be aware of the following when you submit a bug report:
33+
34+
1. Ask on the server first (this is preferred). If you are unsure about an issue, please contact the owner for clarification.
35+
2. Don't open duplicate issues. Please search your issue to see if it has been asked already. Duplicate issues will be closed.
36+
3. When filing a bug about exceptions or stacktrace, please include the complete stacktrace. Without the complete stacktrace the issue might be unsolvable and you will be asked to provide more information.
37+
38+
If a bug report is not clear enough, or missing these information, then more than likely
39+
it'll take longer to fix the bug, or it'll be closed. More than likely clarification will
40+
be asked in order to aid in this process.
41+
42+
## Submitting a Pull Request
43+
44+
This process is fairly straight forward, but make sure to focus your pull request on a single aspect doesn't manage to have scope creep and it's probably good to go.
45+
Ideally the style needs to be consistent but this is fine if it is not met. This project follows PEP-8 guidelines, with an column limit of 88.
46+
47+
## Git Commit Guidelines
48+
49+
1. Use present tense and imperative mood when writing commit messages. For example, `Add new feature` instead of `Added new feature`.
50+
2. Reference issues or pull requests outside of the first line.
51+
a. Please use the shorthand ``#123`` and not the full URL.
52+
53+
If these guidelines are not met, chances are they will be fixed during the review process.

‎.github/PULL_REQUEST_TEMPLATE.md

+2-3
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
## Types of changes
66

7-
What types of changes does your code introduce to Rodhaj
7+
What types of changes does your code introduce to Rodhaj?
88
_Put an `x` in the boxes that apply_
99

1010
- [ ] Bugfix (non-breaking change which fixes an issue)
@@ -13,14 +13,13 @@ _Put an `x` in the boxes that apply_
1313
- [ ] Documentation Update (Updates to README.md, the documentation, etc)
1414
- [ ] Other (if none of the other choices apply)
1515

16-
1716
## Checklist
1817

1918
<!-- Put an x inside [ ] to check it, like so: [x] -->
2019

2120
_Put an `x` in the boxes that apply_
2221

2322
- [ ] If code changes were made then they have been tested.
24-
- [ ] I have updated the documentation to reflect the changes. (if appropriate)
23+
- [ ] I have updated the documentation to reflect the changes. (if appropriate)
2524
- [ ] All workflows (except pre-commit.ci) pass with my new changes
2625
- [ ] This PR does **not** address a duplicate issue or PR

‎docs/Makefile

+3
Original file line numberDiff line numberDiff line change
@@ -18,3 +18,6 @@ help:
1818
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
1919
%: Makefile
2020
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
21+
22+
autobuild:
23+
sphinx-autobuild . build/html

0 commit comments

Comments
 (0)