Skip to content

Commit a5acb3f

Browse files
author
Jan Lenoch
committed
Add/update issue, PR templates, code of conduct, contributing guide
DC-399
1 parent c57621b commit a5acb3f

File tree

2 files changed

+117
-7
lines changed

2 files changed

+117
-7
lines changed

CODE_OF_CONDUCT.md

+43-6
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,48 @@
1-
# Code of Conduct
1+
# Contributor Covenant Code of Conduct
22

3-
The Kentico team is committed to fostering a welcoming community.
3+
## Our Pledge
44

5-
**Our Code of Conduct can be found here**:
5+
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.
66

7-
https://github.com/Kentico/Home/blob/master/CODE_OF_CONDUCT.md
7+
## Our Standards
88

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

11-
https://github.com/Kentico/Home/commits/master/CODE_OF_CONDUCT.md
11+
* Using welcoming and inclusive language
12+
* Being respectful of differing viewpoints and experiences
13+
* Gracefully accepting constructive criticism
14+
* Focusing on what is best for the community
15+
* Showing empathy towards other community members
16+
17+
Examples of unacceptable behavior by participants include:
18+
19+
* The use of sexualized language or imagery and unwelcome sexual attention or advances
20+
* Trolling, insulting/derogatory comments, and personal or political attacks
21+
* Public or private harassment
22+
* Publishing others' private information, such as a physical or electronic address, without explicit permission
23+
* Other conduct which could reasonably be considered inappropriate in a professional setting
24+
25+
## Our Responsibilities
26+
27+
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.
28+
29+
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.
30+
31+
## Scope
32+
33+
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.
34+
35+
## Enforcement
36+
37+
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [email protected]. 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.
38+
39+
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.
40+
41+
## Attribution
42+
43+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [https://contributor-covenant.org/version/1/4][version]
44+
45+
[homepage]: https://contributor-covenant.org
46+
[version]: https://contributor-covenant.org/version/1/4/
47+
48+
![Analytics](https://kentico-ga-beacon.azurewebsites.net/api/UA-69014260-4/Kentico/Home/master/CODE_OF_CONDUCT.md?pixel)

CONTRIBUTING.md

+74-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,76 @@
11
# Contributing guidelines
22

3-
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.
3+
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.
4+
5+
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.
6+
7+
8+
## I have an idea for a new feature
9+
10+
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.
11+
12+
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).
13+
14+
15+
## I found a bug
16+
17+
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
18+
19+
- Steps to reproduce the issue
20+
- Environment and software version used
21+
- Screenshot
22+
- Error message
23+
- What is the expected behavior
24+
25+
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.
26+
27+
28+
## Submitting pull requests
29+
30+
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.
31+
32+
33+
### Example - process of contribution
34+
35+
1. ```Tom``` forks this repository
36+
2. Creates a new branch for his ```cool``` feature
37+
3. Hacks his code
38+
4. Writes some tests
39+
5. Once he's happy with the changes, he submits a pull request from his ```cool``` branch to ```master``` branch
40+
6. We discuss the pull request with ```Tom``` and maybe suggest some adjustments
41+
7. Once the code is ready, someone from maintainers will merge it into the ```master``` branch
42+
43+
44+
### Definition of Done
45+
46+
- Code requirements:
47+
- Code is buildable
48+
- All tests are green
49+
- Code design follows the .NET [Framework Design Guidelines](https://msdn.microsoft.com/en-us/library/ms229042.aspx)
50+
- If you're not sure about some rules, follow the style of the existing code.
51+
- 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)
52+
- Documentation is updated
53+
54+
55+
56+
### Learn how to write good commit messages
57+
58+
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.
59+
60+
- [Writing good commit messages](https://github.com/erlang/otp/wiki/Writing-good-commit-messages)
61+
- [A Note About Git Commit Messages](https://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html)
62+
- [On commit messages](https://who-t.blogspot.com/2009/12/on-commit-messages.html)
63+
64+
## Code of Conduct
65+
66+
The Kentico team is committed to fostering a welcoming community.
67+
68+
**Our Code of Conduct can be found here**:
69+
70+
https://github.com/Kentico/Home/blob/master/CODE_OF_CONDUCT.md
71+
72+
For a history of updates, see the page history here:
73+
74+
https://github.com/Kentico/Home/commits/master/CODE_OF_CONDUCT.md
75+
76+
![Analytics](https://kentico-ga-beacon.azurewebsites.net/api/UA-69014260-4/Kentico/Home/master/CONTRIBUTING.md?pixel)

0 commit comments

Comments
 (0)