diff --git a/.github/CODE_OF_CONDUCT.md b/.github/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..121b810 --- /dev/null +++ b/.github/CODE_OF_CONDUCT.md @@ -0,0 +1,78 @@ + +# Code of Conduct + +## Our Pledge + +In the interest of fostering an open and welcoming environment, we as +contributors and maintainers pledge to make participation in our project and +our community a harassment-free experience for everyone, regardless of age, body +size, disability, ethnicity, sex characteristics, gender identity and expression, +level of experience, education, socio-economic status, nationality, personal +appearance, race, religion, or sexual identity and orientation. + +## Our Standards + +Examples of behavior that contributes to creating a positive environment +include: + +* 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 within all project spaces, and it also applies when +an individual is representing the project or its community in public spaces. +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 `support AT stackgen.com`. All +complaints will be reviewed and investigated and will result in a response that +is deemed necessary and 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://www.contributor-covenant.org/version/1/4/code-of-conduct.html + +[homepage]: https://www.contributor-covenant.org + +For answers to common questions about this code of conduct, see +https://www.contributor-covenant.org/faq + diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md new file mode 100644 index 0000000..45f6357 --- /dev/null +++ b/.github/CONTRIBUTING.md @@ -0,0 +1,44 @@ +# How to contribute + +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. + +Please check the [README](../README.md) to understand the project. + +## Getting started + +To contribute to the project, please: + +1. Fork this repository +2. Create a branch +3. Commit your changes +4. Push your commits to the branch +5. Submit a pull request + +Any material change to the released artifact(s) should be accompanied by a `CHANGELOG.md` entry. + +For further guidance about getting started, please refer to the related links: + +* [Pull Request Guidelines](PULL_REQUEST_TEMPLATE.md) +* Issues Guidelines + * [Bug Report](ISSUE_TEMPLATE/bug_report.md) + * [Bug Report](ISSUE_TEMPLATE/feature_request.md) + +## Change Tracking + +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 +an entry in `CHANGELOG.md`'s `[UNRELEASED]` section (do not directly modify a version's changes, this is automatic). + +Changelog entries should be organized into appropriate headings per +[Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and follow the format: + +```md +- : (#) +``` + +## Coding conventions + +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. + +## Code of Conduct + +This project and everyone participating in it is governed by this [Code of Conduct](CODE_OF_CONDUCT.md). diff --git a/README.md b/README.md index 8da925e..a09181e 100644 --- a/README.md +++ b/README.md @@ -43,3 +43,7 @@ object CpgExtSchema { ``` See also [example](example/build.gradle.kts) + +## Contributing + +Please read [CONTRIBUTING.md](.github/CONTRIBUTING.md) for details on contributing and our code of conduct.