Skip to content

Commit 75cffab

Browse files
authored
Add CONTRIBUTING.md and CODE_OF_CONDUCT.md guidelines (#1)
1 parent e13f89d commit 75cffab

File tree

3 files changed

+126
-0
lines changed

3 files changed

+126
-0
lines changed

.github/CODE_OF_CONDUCT.md

Lines changed: 78 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
1+
2+
# Code of Conduct
3+
4+
## Our Pledge
5+
6+
In the interest of fostering an open and welcoming environment, we as
7+
contributors and maintainers pledge to make participation in our project and
8+
our community a harassment-free experience for everyone, regardless of age, body
9+
size, disability, ethnicity, sex characteristics, gender identity and expression,
10+
level of experience, education, socio-economic status, nationality, personal
11+
appearance, race, religion, or sexual identity and orientation.
12+
13+
## Our Standards
14+
15+
Examples of behavior that contributes to creating a positive environment
16+
include:
17+
18+
* Using welcoming and inclusive language
19+
* Being respectful of differing viewpoints and experiences
20+
* Gracefully accepting constructive criticism
21+
* Focusing on what is best for the community
22+
* Showing empathy towards other community members
23+
24+
Examples of unacceptable behavior by participants include:
25+
26+
* The use of sexualized language or imagery and unwelcome sexual attention or
27+
advances
28+
* Trolling, insulting/derogatory comments, and personal or political attacks
29+
* Public or private harassment
30+
* Publishing others' private information, such as a physical or electronic
31+
address, without explicit permission
32+
* Other conduct which could reasonably be considered inappropriate in a
33+
professional setting
34+
35+
## Our Responsibilities
36+
37+
Project maintainers are responsible for clarifying the standards of acceptable
38+
behavior and are expected to take appropriate and fair corrective action in
39+
response to any instances of unacceptable behavior.
40+
41+
Project maintainers have the right and responsibility to remove, edit, or
42+
reject comments, commits, code, wiki edits, issues, and other contributions
43+
that are not aligned to this Code of Conduct, or to ban temporarily or
44+
permanently any contributor for other behaviors that they deem inappropriate,
45+
threatening, offensive, or harmful.
46+
47+
## Scope
48+
49+
This Code of Conduct applies within all project spaces, and it also applies when
50+
an individual is representing the project or its community in public spaces.
51+
Examples of representing a project or community include using an official
52+
project e-mail address, posting via an official social media account, or acting
53+
as an appointed representative at an online or offline event. Representation of
54+
a project may be further defined and clarified by project maintainers.
55+
56+
## Enforcement
57+
58+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
59+
reported by contacting the project team at `support AT stackgen.com`. All
60+
complaints will be reviewed and investigated and will result in a response that
61+
is deemed necessary and appropriate to the circumstances. The project team is
62+
obligated to maintain confidentiality with regard to the reporter of an incident.
63+
Further details of specific enforcement policies may be posted separately.
64+
65+
Project maintainers who do not follow or enforce the Code of Conduct in good
66+
faith may face temporary or permanent repercussions as determined by other
67+
members of the project's leadership.
68+
69+
## Attribution
70+
71+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
72+
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
73+
74+
[homepage]: https://www.contributor-covenant.org
75+
76+
For answers to common questions about this code of conduct, see
77+
https://www.contributor-covenant.org/faq
78+

.github/CONTRIBUTING.md

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
# How to contribute
2+
3+
We are happy to welcome new contributors and make the contribution process as painless as possible. If you have any questions, feel free to open an issue.
4+
5+
Please check the [README](../README.md) to understand the project.
6+
7+
## Getting started
8+
9+
To contribute to the project, please:
10+
11+
1. Fork this repository
12+
2. Create a branch
13+
3. Commit your changes
14+
4. Push your commits to the branch
15+
5. Submit a pull request
16+
17+
Any material change to the released artifact(s) should be accompanied by a `CHANGELOG.md` entry.
18+
19+
For further guidance about getting started, please refer to the related links:
20+
21+
* [Pull Request Guidelines](PULL_REQUEST_TEMPLATE.md)
22+
* Issues Guidelines
23+
* [Bug Report](ISSUE_TEMPLATE/bug_report.md)
24+
* [Bug Report](ISSUE_TEMPLATE/feature_request.md)
25+
26+
## Change Tracking
27+
28+
All changes into the `main` branch should come from a Pull Request with a review from one of the [codeowners](CODEOWNERS) and should generally include
29+
an entry in `CHANGELOG.md`'s `[UNRELEASED]` section (do not directly modify a version's changes, this is automatic).
30+
31+
Changelog entries should be organized into appropriate headings per
32+
[Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and follow the format:
33+
34+
```md
35+
- <contributor>: <Description of change> (#<github issue>)
36+
```
37+
38+
## Coding conventions
39+
40+
In order to sanitize coding standards, please follow the [Kotlin Coding Conventions](https://kotlinlang.org/docs/coding-conventions.html). Any changes should pass ktlint and detekt checks.
41+
42+
## Code of Conduct
43+
44+
This project and everyone participating in it is governed by this [Code of Conduct](CODE_OF_CONDUCT.md).

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,3 +43,7 @@ object CpgExtSchema {
4343
```
4444

4545
See also [example](example/build.gradle.kts)
46+
47+
## Contributing
48+
49+
Please read [CONTRIBUTING.md](.github/CONTRIBUTING.md) for details on contributing and our code of conduct.

0 commit comments

Comments
 (0)