Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update issue templates #2777

Merged
merged 6 commits into from
Jun 12, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
98 changes: 98 additions & 0 deletions .github/CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,98 @@
# Citizen Code of Conduct

## 1. Purpose

A primary goal of ‬the Comprehensive Kerbal Archive Network (CKAN) is to be inclusive to the largest number of contributors, with the most varied and diverse backgrounds possible. As such, we are committed to providing a friendly, safe and welcoming environment for all, regardless of gender, sexual orientation, ability, ethnicity, socioeconomic status, and religion (or lack thereof).

This code of conduct outlines our expectations for all those who participate in our community, as well as the consequences for unacceptable behavior.

We invite all those who participate in ‬the Comprehensive Kerbal Archive Network (CKAN) to help us create safe and positive experiences for everyone.

## 2. Open Source Citizenship

A supplemental goal of this Code of Conduct is to increase open source citizenship by encouraging participants to recognize and strengthen the relationships between our actions and their effects on our community.

Communities mirror the societies in which they exist and positive action is essential to counteract the many forms of inequality and abuses of power that exist in society.

If you see someone who is making an extra effort to ensure our community is welcoming, friendly, and encourages all participants to contribute to the fullest extent, we want to know.

## 3. Expected Behavior

The following behaviors are expected and requested of all community members:

* Participate in an authentic and active way. In doing so, you contribute to the health and longevity of this community.
* Exercise consideration and respect in your speech and actions.
* Attempt collaboration before conflict.
* Refrain from demeaning, discriminatory, or harassing behavior and speech.
* Be mindful of your surroundings and of your fellow participants. Alert community leaders if you notice a dangerous situation, someone in distress, or violations of this Code of Conduct, even if they seem inconsequential.
* Remember that community event venues may be shared with members of the public; please be respectful to all patrons of these locations.

## 4. Unacceptable Behavior

The following behaviors are considered harassment and are unacceptable within our community:

* Violence, threats of violence or violent language directed against another person.
* Sexist, racist, homophobic, transphobic, ableist or otherwise discriminatory jokes and language.
* Posting or displaying sexually explicit or violent material.
* Posting or threatening to post other people's personally identifying information ("doxing").
* Personal insults, particularly those related to gender, sexual orientation, race, religion, or disability.
* Inappropriate photography or recording.
* Inappropriate physical contact. You should have someone's consent before touching them.
* Unwelcome sexual attention. This includes, sexualized comments or jokes; inappropriate touching, groping, and unwelcomed sexual advances.
* Deliberate intimidation, stalking or following (online or in person).
* Advocating for, or encouraging, any of the above behavior.
* Sustained disruption of community events, including talks and presentations.

## 5. Weapons Policy

No weapons will be allowed at ‬the Comprehensive Kerbal Archive Network (CKAN) events, community spaces, or in other spaces covered by the scope of this Code of Conduct. Weapons include but are not limited to guns, explosives (including fireworks), and large knives such as those used for hunting or display, as well as any other item used for the purpose of causing injury or harm to others. Anyone seen in possession of one of these items will be asked to leave immediately, and will only be allowed to return without the weapon. Community members are further expected to comply with all state and local laws on this matter.

## 6. Consequences of Unacceptable Behavior

Unacceptable behavior from any community member, including sponsors and those with decision-making authority, will not be tolerated.

Anyone asked to stop unacceptable behavior is expected to comply immediately.

If a community member engages in unacceptable behavior, the community organizers may take any action they deem appropriate, up to and including a temporary ban or permanent expulsion from the community without warning (and without refund in the case of a paid event).

## 7. Reporting Guidelines

If you are subject to or witness unacceptable behavior, or have any other concerns, please notify a community organizer as soon as possible. Contact details are provided below.

Additionally, community organizers are available to help community members engage with local law enforcement or to otherwise help those experiencing unacceptable behavior feel safe. In the context of in-person events, organizers will also provide escorts as desired by the person experiencing distress.

## 8. Addressing Grievances

If you feel you have been falsely or unfairly accused of violating this Code of Conduct, you should notify one of the admins with a concise description of your grievance. Your grievance will be handled in accordance with our existing governing policies. Contact details are provided below.

## 9. Scope

We expect all community participants (contributors, paid or otherwise; sponsors; and other guests) to abide by this Code of Conduct in all community venues--online and in-person--as well as in all one-on-one communications pertaining to community business.

This code of conduct and its related procedures also applies to unacceptable behavior occurring outside the scope of community activities when such behavior has the potential to adversely affect the safety and well-being of community members.

## 10. Contact info

Myk Dowling, Mission Director.

IRC: politas on [irc.esper.net](https://esper.net)

Twitter: [@mykdowling](https://twitter.com/mykdowling)

KSP forums: [politas](https://forum.kerbalspaceprogram.com/index.php?/profile/119649-politas/)

Email: politas@gmail.com

## 11. License and attribution

The Citizen Code of Conduct is distributed by [Stumptown Syndicate](http://stumptownsyndicate.org) under a [Creative Commons Attribution-ShareAlike license](http://creativecommons.org/licenses/by-sa/3.0/).

Portions of text derived from the [Django Code of Conduct](https://www.djangoproject.com/conduct/) and the [Geek Feminism Anti-Harassment Policy](http://geekfeminism.wikia.com/wiki/Conference_anti-harassment/Policy).

_Revision 2.3. Posted 6 March 2017._

_Revision 2.2. Posted 4 February 2016._

_Revision 2.1. Posted 23 June 2014._

_Revision 2.0, adopted by the [Stumptown Syndicate](http://stumptownsyndicate.org) board on 10 January 2013. Posted 17 March 2013._
176 changes: 176 additions & 0 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,176 @@
# Contributing to CKAN

:+1::tada: First off, thanks for taking the time to contribute! :tada::+1:

The following is a set of guidelines for contributing to the Comprehensive Kerbal Archive Network. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.

#### Table Of Contents

* [Code of Conduct](#code-of-conduct)
* [Reporting issues](#reporting-issues)
* [Reporting a bug](#reporting-a-bug)
* [Requesting a new feature](#requesting-a-new-feature)
* [Helping with issues](#helping-with-issues)
* [Verifying issues](#verifying-issues)
* [Testing patches](#testing-patches)
* [Translating](#translating)
* [Creating pull requests](#creating-pull-requests)
* [Creating a patch](#creating-a-patch)
* [Creating a pull request](#creating-a-pull-request)
* [Rebasing a pull request](#rebasing-a-pull-request)
* [Keeping your branch up-to-date](#keeping-your-branch-up-to-date)
* [Coding conventions](#coding-conventions)

## Code of Conduct

This project and everyone participating in it is governed by the [CKAN Code of Conduct][1]. By participating, you are expected to uphold this code. Please report unacceptable behavior to mykdowling@gmail.com.

## Reporting issues
### Reporting a bug

If you've found a problem in CKAN, do a search on GitHub under [Issues][2] in case it has already been reported.

If you are unable to find any open GitHub issues addressing the problem you found, your next step will be to [open a new one][2] using the respective 'Bug' template.

Your issue report should contain a title and as much relevant information as possible of the issue. Your goal should be to make it easy for yourself - and others - to reproduce the bug and figure out a fix.

### Requesting a new feature

If there's a new feature that you want to see added to CKAN, you can [open an issue][2] using the respective 'Feature' template, or you can write the code yourself.

## Helping with issues
### Verifying issues

For starters, it helps just to verify bug reports. Can you reproduce the reported issue on your own computer? If so, you can add a comment to the issue saying that you're seeing the same thing.

If an issue is very vague, can you help narrow it down to something more specific? Maybe you can provide additional information to help reproduce a bug, or help by eliminating needless steps that aren't required to demonstrate the problem.

### Testing patches

You can also help out by examining pull requests that have been submitted to CKAN via GitHub. In order to apply someone's changes, you need to first create a dedicated branch:

```
$ git clone https://github.com/KSP-CKAN/CKAN.git
$ cd CKAN
$ git checkout -b testing_branch
```

Then, you can use their remote branch to update your codebase. For example, let's say the GitHub user JohnSmith has forked and pushed to a topic branch "orange" located at https://github.com/JohnSmith/CKAN.

```
$ git remote add JohnSmith https://github.com/JohnSmith/CKAN.git
$ git fetch JohnSmith
$ git checkout JohnSmith/orange
```

After applying their branch, test it out! Comment on the GitHub issue to apply some changes or by giving your approval.

## Translating

We recently started working on translating CKAN and are happy to have people volunteer to translate with us. Just follow these steps:

* Fork this repository by clicking on the 'Fork' button on the top of this page.

* Click on the green 'Clone' button and copy the link.

* Open a terminal and run following code:

```
$ git clone https://github.com/YourName/CKAN.git
$ cd CKAN
$ git checkout -b new_branch
```

* Add a folder for your own language, for example: ` GUI/Localization/it-IT` for Italian.

* Copy the contents of ` GUI/Localization/en-US` into your own language folder.

* Rename the files from `en-US` to `it-IT`.

* Start translating the files.

**Translations we already have:**

* English (US)
* English (AU)
* German

## Creating pull requests

Before you make a pull request, you have to agree to contribute under these licenses:

* Contributions to the CKAN source *must* be licensed under the [MIT license][3].

* Contributions of CKAN metadata files (.netkan or .ckan) *must* be be contributed under the [CC-0][4] license.

### Creating a patch

* Fork this repository by clicking on the 'Fork' button on the top of this page.

* Click on the green 'Clone' button and copy the link.

* Open a terminal and run following code:

```
$ git clone https://github.com/YourName/CKAN.git
HebaruSan marked this conversation as resolved.
Show resolved Hide resolved
$ cd CKAN
$ git remote add upstream https://github.com/KSP-CKAN/CKAN.git
$ git checkout -b new_branch
```

* Now get busy and add/edit code. Make sure to follow our [Coding conventions](#coding-conventions).

* Commit your changes:

```
$ git add -A
$ git commit -m "Brief description of your change"
$ git push origin new_branch
```

### Creating a pull request

* Open a new GitHub pull request with your patch.

* Ensure the PR description clearly describes the problem and solution. Include the relevant issue number if applicable.

Olympic1 marked this conversation as resolved.
Show resolved Hide resolved
### Rebasing a pull request

It can sometimes happen that other commits get merged into the master branch and that your pull request will need a rebase.

```
$ git fetch --all
$ git checkout new_branch
$ git rebase upstream/master
```

## Keeping your branch up-to-date

To keep your 'master' branch up-to-date, you can run following commands:

```
$ git fetch --all
$ git checkout master
$ git pull upstream/master
```

## Coding conventions

This is open source software. Consider the people who will read your code, and make it look nice for them.

* Four spaces, no tabs (for indentation).
* No trailing whitespace. Blank lines should not have any spaces.
* Use `a = b` and not `a=b`.
* Follow the conventions in the source you see used already.

the Comprehensive Kerbal Archive Network (CKAN) is a volunteer effort. We encourage you to pitch in and [join the team][5]!

Thanks! :heart: :heart: :heart:

The CKAN Team

[1]: https://github.com/KSP-CKAN/CKAN/blob/master/.github/CODE_OF_CONDUCT.md
[2]: https://github.com/KSP-CKAN/CKAN/issues
[3]: https://github.com/KSP-CKAN/CKAN/blob/master/LICENSE.md
[4]: https://creativecommons.org/publicdomain/zero/1.0/
[5]: https://github.com/KSP-CKAN/CKAN/graphs/contributors
40 changes: 40 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
---
name: Bug report
about: Create a report to help us improve CKAN
title: "[Bug]"
labels: Bug
assignees: ''

---

Background
-------------
* Operating System:
* CKAN Version:
* KSP Version:

**Have you made any manual changes to your GameData folder (i.e., not via CKAN)?**


Problem
---------
**Describe the bug**


**Steps to reproduce**
* Go to...
* Click on...
* See error

**Expected behavior**


**Screenshots (if applicable)**



**CKAN error code (if applicable):**<details><summary>Click to expand</summary>
```
PLACE CODE HERE !
```
</details>
23 changes: 23 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
name: Feature request
about: Suggest an idea for CKAN
title: "[Feature]"
labels: Enhancement
assignees: ''

---

Problem
---------
**Is your feature request related to a problem? Please describe.**
Ex. I'm always frustrated when...

Suggestions
-------------
**Describe the solution you'd like**


**Describe alternatives you've considered**


**Additional context**
Loading