Skip to content

Commit 8842bcc

Browse files
committed
Fixed missing docs
1 parent b0b049d commit 8842bcc

File tree

4 files changed

+795
-0
lines changed

4 files changed

+795
-0
lines changed

Diff for: CODE_OF_CONDUCT.md

+76
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
In the interest of fostering an open and welcoming environment, we as
6+
contributors and maintainers pledge to making participation in our project and
7+
our community a harassment-free experience for everyone, regardless of age, body
8+
size, disability, ethnicity, sex characteristics, gender identity and expression,
9+
level of experience, education, socio-economic status, nationality, personal
10+
appearance, race, religion, or sexual identity and orientation.
11+
12+
## Our Standards
13+
14+
Examples of behavior that contributes to creating a positive environment
15+
include:
16+
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
22+
23+
Examples of unacceptable behavior by participants include:
24+
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
33+
34+
## Our Responsibilities
35+
36+
Project maintainers are responsible for clarifying the standards of acceptable
37+
behavior and are expected to take appropriate and fair corrective action in
38+
response to any instances of unacceptable behavior.
39+
40+
Project maintainers have the right and responsibility to remove, edit, or
41+
reject comments, commits, code, wiki edits, issues, and other contributions
42+
that are not aligned to this Code of Conduct, or to ban temporarily or
43+
permanently any contributor for other behaviors that they deem inappropriate,
44+
threatening, offensive, or harmful.
45+
46+
## Scope
47+
48+
This Code of Conduct applies both within project spaces and in public spaces
49+
when an individual is representing the project or its community. Examples of
50+
representing a project or community include using an official project e-mail
51+
address, posting via an official social media account, or acting as an appointed
52+
representative at an online or offline event. Representation of a project may be
53+
further defined and clarified by project maintainers.
54+
55+
## Enforcement
56+
57+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
58+
reported by contacting the project team at [email protected]. All
59+
complaints will be reviewed and investigated and will result in a response that
60+
is deemed necessary and appropriate to the circumstances. The project team is
61+
obligated to maintain confidentiality with regard to the reporter of an incident.
62+
Further details of specific enforcement policies may be posted separately.
63+
64+
Project maintainers who do not follow or enforce the Code of Conduct in good
65+
faith may face temporary or permanent repercussions as determined by other
66+
members of the project's leadership.
67+
68+
## Attribution
69+
70+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
71+
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
72+
73+
[homepage]: https://www.contributor-covenant.org
74+
75+
For answers to common questions about this code of conduct, see
76+
https://www.contributor-covenant.org/faq

Diff for: CONTRIBUTING.md

+33
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# How to Contribute
2+
3+
First off, thanks for taking the time to contribute!
4+
5+
### Reporting Bugs
6+
7+
Before oppening a bug report:
8+
9+
- **Make sure the bug is not already reported** searching on GitHub under Issues.
10+
- **Check the FAQs on the Wiki** for a list of common questions and problems.
11+
- **Do not open a bug report to ask questions**. Ask them on [RP Tools forum](https://forums.rptools.net/viewtopic.php?f=85&t=28435) or MapTool's [Discord](https://discord.com/invite/hbn2bfn)
12+
13+
If you didn't find an existing issue for the problem, open a new one using the Bug report template and add a **clear title and decription**, including steps on how to reproduce the problem and MapTool and Framework versions.
14+
15+
### Suggesting Features
16+
17+
Before oppening a feature request:
18+
19+
- Check the **Wiki**, maybe the feature is already available.
20+
- Check if the feature you want is not already requested searching on GitHub under Issues.
21+
22+
If the feature or request doesn't exist, open a new one using the Feature request template and add a **clear title and decription**, include why you think the feature is important and feel free to suggest how to implement it.
23+
24+
### Writing articles on the Wiki
25+
26+
You can help a lot by writing articles and guides on the wiki pages, if you don't know where to start, open the Wiki and search for a topic that you understand, if it's incomplete, feel free to improve, if it doesn't exist, feel free to create a new page.
27+
28+
Before creating a new page:
29+
30+
- Be sure the subject isn't alredy adressed under another title.
31+
- If you want to write about a workaround for a bug, or missing feature, open a bug repport or feature request instead.
32+
33+
You can also change the wikis to fix grammar and spelling, include clearer language or detail features.

0 commit comments

Comments
 (0)