From 896187ed42d2d41cd1b70ee09e3004a27b707b6b Mon Sep 17 00:00:00 2001 From: Mark Omarov <15357910+mark-omarov@users.noreply.github.com> Date: Thu, 5 Jan 2023 20:13:25 +0900 Subject: [PATCH 1/2] style: reformat bug report and feature request templates --- .github/ISSUE_TEMPLATE/bug_report.md | 9 +++++++-- .github/ISSUE_TEMPLATE/feature_request.md | 6 +++++- 2 files changed, 12 insertions(+), 3 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 8d7b575..85d406e 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -8,17 +8,22 @@ assignees: '' --- **Describe the bug** + A clear and concise description of what the bug is. **To Reproduce** + Steps to reproduce the behavior: **Expected behavior** + A clear and concise description of what you expected to happen. **Environment** - - OS: [e.g. MacOS 13.0.1] - - Version: [e.g. 1.0.0] + +- OS: [e.g. MacOS 13.0.1] +- Version: [e.g. 1.0.0] **Additional context** + Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index 78058ca..7cf33b2 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -8,10 +8,14 @@ assignees: '' --- **Description** + A clear and concise description of what you want to happen. **Describe alternatives you've considered** -A clear and concise description of any alternative solutions or features you've considered. + +A clear and concise description of any alternative solutions or features you've +considered. **Additional context** + Add any other context or screenshots about the feature request here. From dae28eb3c52537986d4b514d7b01be856a928ac7 Mon Sep 17 00:00:00 2001 From: Mark Omarov <15357910+mark-omarov@users.noreply.github.com> Date: Thu, 5 Jan 2023 20:13:49 +0900 Subject: [PATCH 2/2] docs: add code of conduct and contribution rules --- CODE_OF_CONDUCT.md | 74 ++++++++++++++++++++++++++++++++++++++++++++++ CONTRIBUTING.md | 67 +++++++++++++++++++++++++++++++++++++++++ 2 files changed, 141 insertions(+) create mode 100644 CODE_OF_CONDUCT.md create mode 100644 CONTRIBUTING.md diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..e967f6c --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,74 @@ +# Contributor Covenant Code of Conduct + +## Our Pledge + +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, 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 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 {{ email }}. 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 diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..45e08ee --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,67 @@ +# Contributing + +## Table of contents + +- [Setting Up the Environment](#setting-up-the-environment) +- [Submitting a Pull Request](#submitting-a-pull-request--pr-) +- [Code Style Guidelines](#code-style-guidelines) +- [Commit Message Guidelines](#commit-message-guidelines) + +## Setting Up the Environment + +1. Install Deno following the [official documentation][deno-install] if not + installed. +2. Run `deno cache --reload --lock=deno.lock src/main.ts` to cache dependencies. +3. Optionally setup your editor/IDE following the + [official documentation][deno-env]. If you don't setup automatic formatting, + please run `deno fmt` before committing your changes. + +## Submitting a Pull Request (PR) + +Before you submit your Pull Request (PR) consider the following guidelines: + +- Search [GitHub][github-prs] for an open or closed PR that relates to your + submission. You don't want to duplicate effort. +- Fork repository and make your changes in a new git branch: + ```bash + git checkout -b feature-branch main + ``` +- Make sure your changes are following the + [code style guidelines](#code-style-guidelines). +- Commit your changes following our + [commit message guidelines](#commit-message-guidelines). +- Push your changes to GitHUb: + ```bash + git push origin feature-branch + ``` +- Create your PR on GitHub pointing to `gh-contribution-mate:main`. + +## Code Style Guidelines + +We follow Deno formatting and linting. You can automatically apply formatting +rules with [deno fmt][deno-fmt], and lint with [deno lint][deno-lint]. + +## Commit Message Guidelines + +We are following [Conventional Commits][conventional-commits] convention to +format commit messages. + +Following types available: + +- feat: A new feature +- fix: A bug fix +- docs: Documentation only changes +- style: Changes that do not affect the meaning of the code (white-space, + formatting, missing semi-colons, etc) +- refactor: A code change that neither fixes a bug nor adds a feature +- perf: A code change that improves performance +- test: Adding missing tests +- chore: Changes to the build process or auxiliary tools and libraries such as + documentation generation + +[deno-install]: https://deno.land/manual@v1.29.1/getting_started/installation +[deno-env]: https://deno.land/manual@v1.29.1/getting_started/setup_your_environment +[github-prs]: https://github.com/trunklabs/gh-contribution-mate/pulls +[deno-fmt]: https://deno.land/manual@v1.29.1/tools/formatter +[deno-lint]: https://deno.land/manual@v1.29.1/tools/linter +[conventional-commits]: https://www.conventionalcommits.org/en/v1.0.0/