Skip to content

Commit

Permalink
doc: Markdownlinted all necessary documentation
Browse files Browse the repository at this point in the history
Files linted include the Code of Conduct, the Contributing Guide, and
both licenses (MIT and CC-BY-NC-SA).
  • Loading branch information
TotallyNotHuman committed Aug 13, 2017
1 parent 2714449 commit ed9997f
Show file tree
Hide file tree
Showing 4 changed files with 112 additions and 90 deletions.
26 changes: 20 additions & 6 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,11 @@
# Kerbae ad Astra Code of Conduct

The Kerbae ad Astra group wishes to extend the warmest welcome to any and all contributors as possible. In order to accomplish this, we ask the following things from you.

## IRC Channel
When visiting the Kerbae ad Astra IRC channel (#kerbaeadastra) on Freenode, accessible through http://webchat.freenode.net, we ask that you be respectful and thoughtful before posting. Any abuse will not be tolerated, and reports can and will be made to the staff members of the channel. This includes the following:

When visiting the Kerbae ad Astra IRC channel (#kerbaeadastra) on Freenode, accessible through <<http://webchat.freenode.net>>, we ask that you be respectful and thoughtful before posting. Any abuse will not be tolerated, and reports can and will be made to the staff members of the channel. This includes the following:

* Sexual or suggestive language
* Links to inappropriate pictures or websites. As a rule-of-thumb, if the KSP Forums would block it, so will we.
* Posting of inappropriate pictures. Using certain clients, it is possible to post pictures directly in chat. See above for the rule-of-thumb.
Expand All @@ -15,16 +18,19 @@ When visiting the Kerbae ad Astra IRC channel (#kerbaeadastra) on Freenode, acce
* To restate all of the above, keep posts on topic and SFW [Safe For Work], and respect other users' beliefs and practices.

## GitLab

To combat spambots, registration on the official Kerbae ad Astra GitLab repository has been disabled. Should you wish to have access to the repository, please contact us at [email protected] and we will consider your case.

Once you have obtained access to the repository, you may submit new issues or MRs [Merge Requests], or comment on existing ones. These comments should be kept on topic and shall not make personal attacks or condescending statements. These include:

* Making a request to close said issue or MR because "you are not experiencing the problem".
* Arguing about the content of issues or MRs, either created by yourself or others.
* Trying to justify issues or MRs after they have been closed by Kerbae ad Astra staff.
* Making issues or MRs without a purpose.
* Unhelpful creation of issues such as "it is completely broken". These do not help anyone in any way, and create much more unnecessary communication and waiting time for the issue to be fixed.

## Staff Members

* 0111narwhalz
* TotallyNotHuman
* KAL 9000
Expand All @@ -33,14 +39,22 @@ Once you have obtained access to the repository, you may submit new issues or MR

We (the staff members) are committed to keeping Kerbae ad Astra and all related places healthy and accepting for all users.

# Consequences for misconduct
### IRC Channel
## Consequences for misconduct

### Consequences: IRC Channel

The consequences for misconduct are available on the IRC channel by typing the command '/msg ChanServ taxonomy #kerbaeadastra' in the chat bar.
### GitLab

### Consequences: GitLab

Misconduct will result in blocking and/or loss of member privileges, up to and including removal of any and all inappropriate wiki edits, commits, comments, issues, and merge requests.

### KSP Forums, including any and all Kerbae ad Astra maintained threads

An immediate report to the KSP forum moderators will be made - punishments (or the lack thereof) will be decided by them.

## Reports of Abuse
### Reports of Abuse

We take abuse very seriously. If you would like to make a complaint of abuse or harassment, please send us an email at [email protected]. We will review each case thoroughly, and may invite you into a private session to discuss the incident. All findings will be kept confidential, unless otherwise stated or requested.
# Thank you for visiting Kerbae ad Astra, and enjoy your stay!

### Thank you for visiting Kerbae ad Astra, and enjoy your stay!
44 changes: 26 additions & 18 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
# Contributing

First of all, thank you for considering contributing to Kerbal Future. We're a small team - only five people at the moment - so we can and will appreciate all the help we can get.

Following these guidelines tells us that you respect our time. In turn, we'll reciprocate that respect by addressing your issue in a timely and friendly fashion.
Expand All @@ -8,43 +9,45 @@ Kerbal Future is an open source project and we welcome contributions from the op
Please don't use the issue tracker for support, questions, or other miscellany. The official IRC channel (#kerbaeadastra on Freenode) can help you with your issue.

## Ground Rules

There is only one important ground rule, and it is as follows:
> Be welcoming to newcomers and encourage diverse new contributors from all backgrounds. See our [Code of Conduct](http://220.231.207.81:591/KerbaeAdAstra/KerbalFuture/blob/develop/CODE_OF_CONDUCT.md).
## Contributing

* Each merge request should implement one, and only one, feature or bug fix. Should you wish to implement or fix more than one feature/bug, submit more than one merge request.
* The commits of each merge request should be directly relevant to the merge request itself. Do not commit changes to files that are irrelevant to the merge request.
* Do not add `using` directives that point to third-party libraries, unless said library is essential to the project. When in doubt, contact the project maintainers.
* Be willing to accept constructive criticism from the project maintainers.
* Be aware that the merge request review process is not immediate, and that the project maintainers have other things to do. Do not pester the project maintainers.
* Low-effort merge requests will generally be rejected.

### Commit message guidelines

The commit message should describe what changed and why.

1. The first line should:
- contain a short description of the change
- be 50 characters or less
- be entirely in lowercase with the exception of proper nouns, acronyms, and programming terms
- be prefixed with the name of the changed subsystem and start with an imperative verb.
* contain a short description of the change
* be 50 characters or less
* be entirely in lowercase with the exception of proper nouns, acronyms, and programming terms
* be prefixed with the name of the changed subsystem and start with an imperative verb.

Examples:
- `doc: fix typos in code of conduct`
- `cfg: add missing PartModule to Spacefolder`
* `doc: fix typos in code of conduct`
* `cfg: add missing PartModule to Spacefolder`

2. Keep the second line blank.
3. Wrap all other lines at 72 columns.
1. Keep the second line blank.
1. Wrap all other lines at 72 columns.

4. If your patch fixes an open issue, you can add a reference to it at the end of the log. Use the `Fixes:` prefix and the full issue URL. For other references, use `Refs:`.
1. If your patch fixes an open issue, you can add a reference to it at the end of the log. Use the `Fixes:` prefix and the full issue URL. For other references, use `Refs:`.

Examples:
- `Fixes: http://220.231.207.81:591/KerbaeAdAstra/KerbalFuture/issues/76`
- `Refs: http://220.231.207.81:591/KerbaeAdAstra/KerbalFuture/merge_requests/83`

* `Fixes: http://220.231.207.81:591/KerbaeAdAstra/KerbalFuture/issues/76`
* `Refs: http://220.231.207.81:591/KerbaeAdAstra/KerbalFuture/merge_requests/83`

Sample complete commit message:

```
```plaintext
subsystem: explain the commit in one line
Body of commit message is a few lines of text, explaining things
Expand All @@ -63,20 +66,25 @@ Refs: http://220.231.207.81:591/KerbaeAdAstra/KerbalFuture/merge_requests/83
## Bug Reporting

### Security Vulnerabilities

If you find a security vulnerability, **DO NOT** open an issue! Send an email to [email protected]. If you're a PGP user, feel free to encrypt to `A00A 5B66 377B EC69 5C4B  8CE8 A7B8 2AD1 4B50 74A3`.

### Bug Reporting Etiquette

To make our work easier, please answer these questions when submitting a bug report:

1. What version of Kerbal Space Program is the mod running on?
2. What version is the mod itself?
3. What operating system and processor architecture are you using?
4. What did you do that caused this bug?
5. What exceptions were thrown?
1. What version is the mod itself?
1. What operating system and processor architecture are you using?
1. What did you do that caused this bug?
1. What exceptions were thrown?

And most importantly, you **must** include the output_log.txt (preferably using the GitLab Snippet function, or thru Pastebin) when submitting a bug report. **NO LOGS = NO SUPPORT.**
And most importantly, you **must** include the output_log.txt (preferably using the GitLab Snippet function, or thru Pastebin) when submitting a bug report. **NO LOGS == NO SUPPORT.**

## Suggesting Features

Kerbal Future is based on a foundation of hard science-fiction. Handwaving is kept to a minimum. Kerbal Future will implement most if not all paradigms of Kerbae ad Astra - see the official Wiki [here](https://github.com/KerbaeAdAstra/wiki/wiki). As such, features requests or suggestions will probably be denied unless it fits in with the universe.

## Community

You can reach the team in several ways. The preferred way is of course IRC - the channel is #kerbaeadastra on Freenode. Alternatively, send an email to [email protected] entitled "To [TEAMMEMBER]".
Loading

0 comments on commit ed9997f

Please sign in to comment.