Skip to content

Commit

Permalink
Merge pull request #32 from Kentico/dc-399-issue-templates
Browse files Browse the repository at this point in the history
Add/update issue, PR templates, code of conduct, contributing guide
  • Loading branch information
Jan Lenoch authored Sep 6, 2018
2 parents 703c3ed + 3f8cc97 commit 57cb488
Show file tree
Hide file tree
Showing 7 changed files with 215 additions and 7 deletions.
34 changes: 34 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
---
name: Bug report
about: Create a report to help us improve

---

### Brief bug description

What went wrong?

### Repro steps

1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error

### Expected behavior

What the correct behavior is?

### Test environment

- Platform/OS: [e.g. .NET Core 2.1, iOS]
- Browser [e.g. chrome, safari]
- Version [e.g. 22]

### Additional context

Add any other context about the problem here.

### Screenshots

Add links to screenshots, if possible.
17 changes: 17 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
name: Feature request
about: Suggest an idea for this project

---

### Motivation

Why is this feature required? What problems does it solve?

### Proposed solution

An ideal solution of the above problems.

### Additional context

Add any other context, screenshots, or reference links about the feature request here.
13 changes: 13 additions & 0 deletions .github/ISSUE_TEMPLATE/question.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
name: Question
about: Ask a question

---

### Question

What do you want to ask?

### Reference

* URL
17 changes: 17 additions & 0 deletions .github/ISSUE_TEMPLATE/spike.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
name: Spike
about: Suggest an analysis of a problem

---

### Expected result

What do we want to explore and why? Which questions do we want to answer with this spike?

### Additional context

Add any other context or guidelines here.

### Resources

* URL
17 changes: 17 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
### Motivation

Which issue does this fix? Fixes #`issue number`

If no issue exists, what is the fix or new feature? Were there any reasons to fix/implement things that are not obvious?

### Checklist

- [ ] Code follows coding conventions held in this repo
- [ ] Automated tests have been added
- [ ] Tests are passing
- [ ] Docu has been updated (if applicable)
- [ ] Temporary settings (e.g. project ID used during development and testing) have been reverted to defaults

### How to test

If manual testing is required, what are the steps?
49 changes: 43 additions & 6 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,48 @@
# Code of Conduct
# Contributor Covenant Code of Conduct

The Kentico team is committed to fostering a welcoming community.
## Our Pledge

**Our Code of Conduct can be found here**:
In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.

https://github.com/Kentico/Home/blob/master/CODE_OF_CONDUCT.md
## Our Standards

For a history of updates, see the page history here:
Examples of behavior that contributes to creating a positive environment include:

https://github.com/Kentico/Home/commits/master/CODE_OF_CONDUCT.md
* Using welcoming and inclusive language
* Being respectful of differing viewpoints and experiences
* Gracefully accepting constructive criticism
* Focusing on what is best for the community
* Showing empathy towards other community members

Examples of unacceptable behavior by participants include:

* The use of sexualized language or imagery and unwelcome sexual attention or advances
* Trolling, insulting/derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or electronic address, without explicit permission
* Other conduct which could reasonably be considered inappropriate in a professional setting

## Our Responsibilities

Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.

Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.

## Scope

This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at DevelopersCommunity@kentico.com. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.

Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [https://contributor-covenant.org/version/1/4][version]

[homepage]: https://contributor-covenant.org
[version]: https://contributor-covenant.org/version/1/4/

![Analytics](https://kentico-ga-beacon.azurewebsites.net/api/UA-69014260-4/Kentico/Home/master/CODE_OF_CONDUCT.md?pixel)
75 changes: 74 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,76 @@
# Contributing guidelines

Take a look at our [general contribution guidelines](https://github.com/Kentico/Home/blob/master/CONTRIBUTING.md) and [readme](https://github.com/Kentico/Home/blob/master/README.md) in our [Home](https://github.com/Kentico/Home) repository.
There are many different ways in which you can contribute. One of them is simply by using our software and providing us with your feedback or you can actively participate by coding some new features.

This guide describes general guidelines that most of the repositories refer to. We don't want to make things complicated so we try to follow the same rules in every repository. But sometimes there are some rules specific for that particular repository. Always check the contributing guideline and readme in that repository as well.


## I have an idea for a new feature

Everybody loves new features! You can submit a new feature request or you can code it on your own and send us a pull request. In either case, don't forget to mention what's the use case and what's the expected output.

It's always a good idea to discuss the feature before you start the implementation. You can check with us whether the feature fits the vision of a given project. We may also give you some useful hints before you start coding. To start chatting, either create a new GitHub issue or contact us via the [repository's default communication channel](https://github.com/Kentico/Home#questions--answers).


## I found a bug

Sorry to hear that. Just create new GitHub issue and someone will take a look at that. Please, don't forget to provide us with all the important information like

- Steps to reproduce the issue
- Environment and software version used
- Screenshot
- Error message
- What is the expected behavior

The more information you provide, the easier would it be to fix the issue. You can also fix the bug on your own and submit a new pull request.


## Submitting pull requests

If not stated otherwise, we use [feature branch workflow](https://www.atlassian.com/git/tutorials/comparing-workflows/feature-branch-workflow). To start with coding, fork the repository you want to contribute to, create a new branch and start coding.


### Example - process of contribution

1. ```Tom``` forks this repository
2. Creates a new branch for his ```cool``` feature
3. Hacks his code
4. Writes some tests
5. Once he's happy with the changes, he submits a pull request from his ```cool``` branch to ```master``` branch
6. We discuss the pull request with ```Tom``` and maybe suggest some adjustments
7. Once the code is ready, someone from maintainers will merge it into the ```master``` branch


### Definition of Done

- Code requirements:
- Code is buildable
- All tests are green
- Code design follows the .NET [Framework Design Guidelines](https://msdn.microsoft.com/en-us/library/ms229042.aspx)
- If you're not sure about some rules, follow the style of the existing code.
- Use "Format the whole document" button in Visual Studio to fix indentation ![format](https://cloud.githubusercontent.com/assets/9810625/12391368/a14d7726-bde7-11e5-9a0f-3310c833f5ca.png)
- Documentation is updated



### Learn how to write good commit messages

We hate sloppy commit messages. No more ```Performance tuning``` or ```Changed a few files```. Please read the following articles to understand what a good commit message is.

- [Writing good commit messages](https://github.com/erlang/otp/wiki/Writing-good-commit-messages)
- [A Note About Git Commit Messages](https://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html)
- [On commit messages](https://who-t.blogspot.com/2009/12/on-commit-messages.html)

## Code of Conduct

The Kentico team is committed to fostering a welcoming community.

**Our Code of Conduct can be found here**:

https://github.com/Kentico/Home/blob/master/CODE_OF_CONDUCT.md

For a history of updates, see the page history here:

https://github.com/Kentico/Home/commits/master/CODE_OF_CONDUCT.md

![Analytics](https://kentico-ga-beacon.azurewebsites.net/api/UA-69014260-4/Kentico/Home/master/CONTRIBUTING.md?pixel)

0 comments on commit 57cb488

Please sign in to comment.