Skip to content

Commit d75e1a3

Browse files
Falki-gitFalki-git
authored
Merge pull request #11 from Falki-git/dev
Add contributing guidelines, issue templates and other
2 parents 40a5c5c + 5b464e8 commit d75e1a3

7 files changed

Lines changed: 270 additions & 0 deletions

File tree

‎.github/CODE_OF_CONDUCT.md‎

Lines changed: 128 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,128 @@
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+
28+
Examples of unacceptable behavior include:
29+
30+
* The use of sexualized language or imagery, and sexual attention or
31+
advances of any kind
32+
* Trolling, insulting or derogatory comments, and personal or political attacks
33+
* Public or private harassment
34+
* Publishing others' private information, such as a physical or email
35+
address, without their explicit permission
36+
* Other conduct which could reasonably be considered inappropriate in a
37+
professional setting
38+
39+
## Enforcement Responsibilities
40+
41+
Community leaders are responsible for clarifying and enforcing our standards of
42+
acceptable behavior and will take appropriate and fair corrective action in
43+
response to any behavior that they deem inappropriate, threatening, offensive,
44+
or harmful.
45+
46+
Community leaders have the right and responsibility to remove, edit, or reject
47+
comments, commits, code, wiki edits, issues, and other contributions that are
48+
not aligned to this Code of Conduct, and will communicate reasons for moderation
49+
decisions when appropriate.
50+
51+
## Scope
52+
53+
This Code of Conduct applies within all community spaces, and also applies when
54+
an individual is officially representing the community in public spaces.
55+
Examples of representing our community include using an official e-mail address,
56+
posting via an official social media account, or acting as an appointed
57+
representative at an online or offline event.
58+
59+
## Enforcement
60+
61+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
62+
reported to the community leaders responsible for enforcement at
63+
Discord.
64+
All complaints will be reviewed and investigated promptly and fairly.
65+
66+
All community leaders are obligated to respect the privacy and security of the
67+
reporter of any incident.
68+
69+
## Enforcement Guidelines
70+
71+
Community leaders will follow these Community Impact Guidelines in determining
72+
the consequences for any action they deem in violation of this Code of Conduct:
73+
74+
### 1. Correction
75+
76+
**Community Impact**: Use of inappropriate language or other behavior deemed
77+
unprofessional or unwelcome in the community.
78+
79+
**Consequence**: A private, written warning from community leaders, providing
80+
clarity around the nature of the violation and an explanation of why the
81+
behavior was inappropriate. A public apology may be requested.
82+
83+
### 2. Warning
84+
85+
**Community Impact**: A violation through a single incident or series
86+
of actions.
87+
88+
**Consequence**: A warning with consequences for continued behavior. No
89+
interaction with the people involved, including unsolicited interaction with
90+
those enforcing the Code of Conduct, for a specified period of time. This
91+
includes avoiding interactions in community spaces as well as external channels
92+
like social media. Violating these terms may lead to a temporary or
93+
permanent ban.
94+
95+
### 3. Temporary Ban
96+
97+
**Community Impact**: A serious violation of community standards, including
98+
sustained inappropriate behavior.
99+
100+
**Consequence**: A temporary ban from any sort of interaction or public
101+
communication with the community for a specified period of time. No public or
102+
private interaction with the people involved, including unsolicited interaction
103+
with those enforcing the Code of Conduct, is allowed during this period.
104+
Violating these terms may lead to a permanent ban.
105+
106+
### 4. Permanent Ban
107+
108+
**Community Impact**: Demonstrating a pattern of violation of community
109+
standards, including sustained inappropriate behavior, harassment of an
110+
individual, or aggression toward or disparagement of classes of individuals.
111+
112+
**Consequence**: A permanent ban from any sort of public interaction within
113+
the community.
114+
115+
## Attribution
116+
117+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
118+
version 2.0, available at
119+
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
120+
121+
Community Impact Guidelines were inspired by [Mozilla's code of conduct
122+
enforcement ladder](https://github.com/mozilla/diversity).
123+
124+
[homepage]: https://www.contributor-covenant.org
125+
126+
For answers to common questions about this code of conduct, see the FAQ at
127+
https://www.contributor-covenant.org/faq. Translations are available at
128+
https://www.contributor-covenant.org/translations.

‎.github/CONTRIBUTING.md‎

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
# Contributing to CommunityResources
2+
3+
Thank you for your interest in contributing to CommunityResources! This document outlines the guidelines for contributing to this project.
4+
5+
## Getting Started
6+
7+
To get started, you will need to have [Git](https://git-scm.com/) and a legit copy of [Kerbal Space Program 2](https://www.kerbalspaceprogram.com/games-kerbal-space-program-2) installed on your machine. You will also need to have a GitHub account.
8+
9+
## Contributing to Issues
10+
11+
We welcome contributions from the community to help us improve CommunityResources. You can contribute by submitting bug reports, feature requests, or code changes.
12+
13+
### Issue Tracker
14+
15+
All contributions to CommunityResources are tracked on the [GitHub issue tracker](https://github.com/KSP2Community/CommunityResources/issues). Before you start working on a feature or issue, please check the issue tracker to make sure that it has not already been reported.
16+
17+
### Reporting Bugs
18+
19+
If you encounter a bug while using CommunityResources, please report it on the issue tracker. When submitting a bug report, please include as much information as possible, including the steps to reproduce the bug and any error messages that you received.
20+
21+
### Feature Requests
22+
23+
If you have an idea for a new feature or improvement to CommunityResources, please submit it on the issue tracker. We encourage you to discuss your idea with the community before submitting a feature request.
24+
25+
### Contributing Code
26+
27+
If you would like to contribute code to CommunityResources, please follow these guidelines:
28+
29+
1. Create a fork of the CommunityResources repository.
30+
2. Clone your fork onto your local machine.
31+
3. Create a new branch for your changes.
32+
4. Make your changes on the new branch.
33+
5. Test your changes to make sure they work as expected.
34+
6. Commit your changes and push them to your fork.
35+
7. Create a pull request for the *DEV* branch of the CommunityResources repository.
36+
37+
### Code Style
38+
39+
Please observe some basic style rules for your contributions:
40+
- Follow the naming guidelines put out by [Microsoft](https://learn.microsoft.com/en-us/dotnet/standard/design-guidelines/naming-guidelines)
41+
- Per indentation level, use a tab, not spaces
42+
- Use Carriage-Return & Line Feed (CRLF) line endings in all C# and Visual Studio source code files. Source files or config files for tools that do not work on Windows and/or can't handle CRLF line endings are exempt.
43+
- Avoid trailing whitespace
44+
- Please document your code briefly with inline-comments. If you add new functions, provide summaries that explain parameters, return values and side effects.
45+
46+
### Good First Issues
47+
48+
We mark some issues as "good first issue" to help new contributors get started with the project. These issues are usually relatively simple and don't require a lot of experience with the project.
49+
50+
## Code of Conduct
51+
52+
We expect all contributors to follow our [Code of Conduct](CODE_OF_CONDUCT.md). Please review this document before contributing to Space Warp.
53+
54+
## License
55+
56+
CommunityResources is licensed under the [MIT License](LICENSE). By contributing to this project, you agree to license your contributions under the same license.

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us resolve a bug or issue
4+
title: "[BUG]"
5+
labels: ''
6+
assignees: ''
7+
8+
---
9+
10+
## Version Information
11+
12+
###### **KSP 2 Version**
13+
The KSP 2 Version
14+
15+
###### **CommunityResources Version**
16+
The CommunityResources Version
17+
18+
------------------------------
19+
20+
## Bug Information
21+
22+
###### **Describe the bug**
23+
A clear and concise description of what the bug is.
24+
25+
###### **To Reproduce**
26+
Steps to reproduce the behavior:
27+
28+
###### **Expected behavior**
29+
A clear and concise description of what you expected to happen.
30+
31+
###### **Link to [crashlog](https://gist.github.com/)** *[If Applicable]*
32+
Ctrl + V here
33+
34+
###### **Screenshots**
35+
If applicable, add screenshots to help explain your problem.
36+
37+
38+
###### **Additional context**
39+
Add any other context about the problem here.

‎.github/ISSUE_TEMPLATE/feature_request.md‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
title: "[FEATURE]"
5+
labels: ''
6+
assignees: ''
7+
8+
---
9+
10+
## Feature Information
11+
12+
###### **Feature description**
13+
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
14+
15+
###### **Solution proposal**
16+
A clear and concise description of how you want to happen.
17+
18+
###### **Additional context**
19+
Add any other context about the feature request here
20+
21+
###### **Screenshots / Images**
22+
Ctrl + V here

LICENSE renamed to .github/LICENSE

File renamed without changes.

README.md renamed to .github/README.md

File renamed without changes.

‎.github/SECURITY.md‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# Security Policy
2+
3+
## Reporting a Vulnerability
4+
5+
If you believe you have found a security vulnerability in CommunityResources, please report it to us as soon as possible.
6+
7+
When reporting a vulnerability, please provide as much information as possible, including:
8+
9+
- A detailed description of the vulnerability and how it can be exploited
10+
- Steps to reproduce the vulnerability
11+
- Any proof-of-concept code or scripts that you used to exploit the vulnerability
12+
13+
We will respond to your report as soon as possible, and will keep you informed throughout the process of resolving the vulnerability.
14+
15+
## Supported Versions
16+
17+
CommunityResources only supports the latest released version of the mod. If you are not using the latest version, please upgrade before reporting any issues or vulnerabilities.
18+
19+
## Scope
20+
21+
This security policy applies to the CommunityResources project, including all code and documentation hosted on GitHub under the KSP2Community organization.
22+
23+
## Contact
24+
25+
If you have any questions or concerns about this security policy, please contact any of the KSP2Community devs at [Discord](https://discord.gg/HQXGXWcWDY)

0 commit comments

Comments
 (0)