From 4bae4512bbbdda6a12288bde86b514b3356ed8f4 Mon Sep 17 00:00:00 2001 From: Matias Volpe Date: Wed, 7 Sep 2022 08:35:06 -0300 Subject: [PATCH] chore: GH Presence (#205) * chore: add CODE_OF_CONDUCT.md * chore: add CONTRIBUTING.md * style: add deno taks lint * chore: add code style to CONTRIBUITING.md * chore: add Contributing to Readme.md * chore: add GH issue and pull request templates * Apply suggestions from code review Co-authored-by: T6 * chore: update contributing guide * chore: update contributing guide * Apply suggestions from code review Co-authored-by: T6 * chore: remove periods in CONTRIBUTING.md lists * Update CONTRIBUTING.md Co-authored-by: T6 Co-authored-by: T6 --- .github/ISSUE_TEMPLATE/BUG_REPORT.md | 45 ++++++++ .github/ISSUE_TEMPLATE/FEATURE_REQUEST.md | 25 ++++ .github/PULL_REQUEST_TEMPLATE.md | 16 +++ .github/workflows/test.yml | 1 + CODE_OF_CONDUCT.md | 132 ++++++++++++++++++++++ CONTRIBUTING.md | 89 +++++++++++++++ Readme.md | 12 +- deno.jsonc | 1 + 8 files changed, 320 insertions(+), 1 deletion(-) create mode 100644 .github/ISSUE_TEMPLATE/BUG_REPORT.md create mode 100644 .github/ISSUE_TEMPLATE/FEATURE_REQUEST.md create mode 100644 .github/PULL_REQUEST_TEMPLATE.md create mode 100644 CODE_OF_CONDUCT.md create mode 100644 CONTRIBUTING.md diff --git a/.github/ISSUE_TEMPLATE/BUG_REPORT.md b/.github/ISSUE_TEMPLATE/BUG_REPORT.md new file mode 100644 index 000000000..44fa66352 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/BUG_REPORT.md @@ -0,0 +1,45 @@ +--- + +name: Bug Report +about: Create a report to help us improve +title: +labels: bug + +--- + +<!-- Please search to see if an issue already exists for the bug you encountered. --> + +**Current Behavior** + +<!-- A concise description of what you're experiencing. --> + +**Expected Behavior** + +<!-- A concise description of what you expected to happen. --> + +**Steps To Reproduce** + +<!-- +Example: steps to reproduce the behavior: +1. In this environment... +2. With this config... +3. Run '...' +4. See error... +--> + +**Environment** + +<!-- +Example: +- Deno: ... (deno --version) +- Node: ... (node -v) +- Browser: ... +- OS: ... +- Language: TypeScript vX.Y.Z (tsc --version) / JavaScript / ... +--> + +**Anything else** + +<!-- +Links? References? Github repository? Anything that will give us more context about the issue that you are encountering! +--> diff --git a/.github/ISSUE_TEMPLATE/FEATURE_REQUEST.md b/.github/ISSUE_TEMPLATE/FEATURE_REQUEST.md new file mode 100644 index 000000000..9a41e0f8e --- /dev/null +++ b/.github/ISSUE_TEMPLATE/FEATURE_REQUEST.md @@ -0,0 +1,25 @@ +--- + +name: Feature Request +about: Suggest an idea for this project +title: <title> +labels: feature + +--- + +<!-- +Thank you for suggesting an idea to make the project better. + +Please fill in as much of the template below as you're able. + +Note: Please search to see if the feature request already exists or has been discussed. +--> + +**Is your feature request related to a problem? Please describe.** +Please describe the problem you are trying to solve. + +**Describe the solution you'd like** +Please describe the desired behavior. + +**Describe alternatives you've considered** +Please describe alternative solutions or features you have considered. diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 000000000..eca8069b1 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,16 @@ +<!--- Provide a general summary of your changes in the title above, following conventional commit --> + +**Description** + +<!--- Link to the open issue this addresses --> + +Fixes # + +<!--- Describe your changes in detail --> + +**How Has This Been Tested?** + +<!--- Please describe in detail how you tested your changes. --> +<!--- Include details of your testing environment, and the tests you ran to --> +<!--- see how your change affects other areas of the code, etc. --> +<!--- validate CI checks passed --> diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml index 97c3808d1..7e14dab1a 100644 --- a/.github/workflows/test.yml +++ b/.github/workflows/test.yml @@ -9,5 +9,6 @@ jobs: - uses: denoland/setup-deno@004814556e37c54a2f6e31384c9e18e983317366 # v1.1.0 with: deno-version: v1.x + - run: deno task lint - run: deno task star - run: deno task test diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 000000000..420a0d6e9 --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,132 @@ +# Contributor Covenant Code of Conduct + +## Our Pledge + +We as members, contributors, and leaders pledge to make participation in our +community a harassment-free experience for everyone, regardless of age, body +size, visible or invisible disability, ethnicity, sex characteristics, gender +identity and expression, level of experience, education, socio-economic status, +nationality, personal appearance, race, caste, color, religion, or sexual +identity and orientation. + +We pledge to act and interact in ways that contribute to an open, welcoming, +diverse, inclusive, and healthy community. + +## Our Standards + +Examples of behavior that contributes to a positive environment for our +community include: + +- Demonstrating empathy and kindness toward other people +- Being respectful of differing opinions, viewpoints, and experiences +- Giving and gracefully accepting constructive feedback +- Accepting responsibility and apologizing to those affected by our mistakes, + and learning from the experience +- Focusing on what is best not just for us as individuals, but for the overall + community + +Examples of unacceptable behavior include: + +- The use of sexualized language or imagery, and sexual attention or advances of + any kind +- Trolling, insulting or derogatory comments, and personal or political attacks +- Public or private harassment +- Publishing others' private information, such as a physical or email address, + without their explicit permission +- Other conduct which could reasonably be considered inappropriate in a + professional setting + +## Enforcement Responsibilities + +Community leaders are responsible for clarifying and enforcing our standards of +acceptable behavior and will take appropriate and fair corrective action in +response to any behavior that they deem inappropriate, threatening, offensive, +or harmful. + +Community leaders 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, and will communicate reasons for moderation +decisions when appropriate. + +## Scope + +This Code of Conduct applies within all community spaces, and also applies when +an individual is officially representing the community in public spaces. +Examples of representing our community include using an official e-mail address, +posting via an official social media account, or acting as an appointed +representative at an online or offline event. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported to the community leaders responsible for enforcement at +<admin@parity.io>. +All complaints will be reviewed and investigated promptly and fairly. + +All community leaders are obligated to respect the privacy and security of the +reporter of any incident. + +## Enforcement Guidelines + +Community leaders will follow these Community Impact Guidelines in determining +the consequences for any action they deem in violation of this Code of Conduct: + +### 1. Correction + +**Community Impact**: Use of inappropriate language or other behavior deemed +unprofessional or unwelcome in the community. + +**Consequence**: A private, written warning from community leaders, providing +clarity around the nature of the violation and an explanation of why the +behavior was inappropriate. A public apology may be requested. + +### 2. Warning + +**Community Impact**: A violation through a single incident or series of +actions. + +**Consequence**: A warning with consequences for continued behavior. No +interaction with the people involved, including unsolicited interaction with +those enforcing the Code of Conduct, for a specified period of time. This +includes avoiding interactions in community spaces as well as external channels +like social media. Violating these terms may lead to a temporary or permanent +ban. + +### 3. Temporary Ban + +**Community Impact**: A serious violation of community standards, including +sustained inappropriate behavior. + +**Consequence**: A temporary ban from any sort of interaction or public +communication with the community for a specified period of time. No public or +private interaction with the people involved, including unsolicited interaction +with those enforcing the Code of Conduct, is allowed during this period. +Violating these terms may lead to a permanent ban. + +### 4. Permanent Ban + +**Community Impact**: Demonstrating a pattern of violation of community +standards, including sustained inappropriate behavior, harassment of an +individual, or aggression toward or disparagement of classes of individuals. + +**Consequence**: A permanent ban from any sort of public interaction within the +community. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], +version 2.1, available at +[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1]. + +Community Impact Guidelines were inspired by +[Mozilla's code of conduct enforcement ladder][Mozilla CoC]. + +For answers to common questions about this code of conduct, see the FAQ at +[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at +[https://www.contributor-covenant.org/translations][translations]. + +[homepage]: https://www.contributor-covenant.org +[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html +[Mozilla CoC]: https://github.com/mozilla/diversity +[FAQ]: https://www.contributor-covenant.org/faq +[translations]: https://www.contributor-covenant.org/translations diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 000000000..b5d6652eb --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,89 @@ +# Contributing + +When contributing to this repository, please check our open issues and whether there is already an issue related to your idea. Please first discuss the change you wish to make in a GitHub issue and wait for a reply from the maintainers of this repository before making a change. + +We have a [code of conduct](CODE_OF_CONDUCT.md); please follow it in all your interactions relating to the project. + +## Rules + +There are a few basic ground-rules for contributors: + +1. **All modifications** must be made in a **pull-request** to solicit feedback from other contributors +2. Contributors should attempt to adhere to the prevailing [code-style](#code-style) + +## Pull requests + +**For a pull request to be merged it must at least:** + +:white_check_mark:   Pass CI + +:white_check_mark:   Have one approving review + +:white_check_mark:   Have the PR title follow [conventional commit](https://www.conventionalcommits.org/) + +**Ideally, a good pull request should:** + +:clock3:   Take less than 15 minutes to review + +:open_book:   Have a meaningful description (describes the problem being solved) + +:one:   Introduce one feature or solve one bug at a time, for which an open issue already exists. In case of a project wide refactoring, a larger PR is to be expected, but the reviewer should be more carefully guided through it + +:jigsaw:   Issues that seem too big for a PR that can be reviewed in 15 minutes or PRs that need to touch other issues should be discussed and probably split differently before starting any development + +:dart:   Handle renaming, moving files, linting and formatting separately (not alongside features or bug fixes) + +:test_tube:   Add tests for new functionality + +**Draft pull requests for early feedback are welcome and do not need to adhere to any guidelines.** + +When reviewing a pull request, the end-goal is to suggest useful changes to the author. Reviews should finish with approval unless there are issues that would result in: + +:x:   Buggy behavior + +:x:   Undue maintenance burden + +:x:   Measurable performance issues + +:x:   Feature reduction (i.e. it removes some aspect of functionality that a significant minority of users rely on) + +:x:   Uselessness (i.e. it does not strictly add a feature or fix a known issue) + +:x:   Disabling a compiler feature to introduce code that wouldn't compile + +## Code style + +We use the following tools to enforce linting rules, formatting and spell checking + +- [`deno lint`](https://deno.land/manual/tools/linter) +- [`dprint`](https://dprint.dev/) +- [`cspell`](https://cspell.org/) + +We encourage adding the [recommended](.vscode/extensions.json) (or similar) extensions to your IDE. + +To run a project wide check you can use: + +```bash +deno lint +dprint fmt # or dprint check +cspell "**/*" +``` + +## Releases + +Declaring formal releases remains the prerogative of the project maintainer(s). + +## License + +By contributing to project, you agree that your contributions will be licensed under its [Apache license](LICENSE). + +## Changes to this arrangement + +This is an experiment and feedback is welcome! This document may also be subject to pull-requests or changes by contributors where you believe you have something valuable to add or change. + +## Heritage + +These contributing guidelines are modified from + +- the "Substrate Project" guidelines https://github.com/paritytech/substrate/blob/master/docs/CONTRIBUTING.adoc +- the "Substrate Contracts UI" guidelines https://github.com/paritytech/contracts-ui/blob/master/CONTRIBUTING.md diff --git a/Readme.md b/Readme.md index 9cc4cb1cf..a12579af7 100644 --- a/Readme.md +++ b/Readme.md @@ -179,7 +179,7 @@ for await (const event of result) { > Note: it is up to the developer to supply `sign` with a signing function, which will vary depending on your environment, wallet, misc. -## Contributing +## Environment setup > In the future, Gitpod and dev containers will simplify spinning up a Capi development environments. The [Dockerfile](./Dockerfile), [Gitpod configuration](./.gitpod.yml) and [Dev Containers / Codespaces configuration](./.devcontainer/devcontainer.json) are in need some finessing. @@ -222,3 +222,13 @@ We no longer need to think about the separation of code for the sake of packagin For example, exports of [`util/types.ts`](./util/types.ts) can be imported directly into any other TypeScript file, without specifying the dependency in a package manifest. We are free to use (for example) `U2I`, the union to intersection utility, in out-of-band processes, the effect system or even GitHub workflow scripts. From anywhere in the repository, we can import and use any code with configuration overhead. When it comes time to [build our code](./tasks/dnt.ts) for NPM distribution, [DNT](https://github.com/denoland/dnt) takes care of transforming our dependency graph into something that NodeJS and web browsers will understand. + +## Contributing + +Contributions are welcome and appreciated! Check out the [contributing guide](CONTRIBUTING.md) before you dive in. + +Everyone interacting in the project is expected to follow the [code of conduct](CODE_OF_CONDUCT.md). + +## License + +Capi is [Apache licensed](LICENSE). diff --git a/deno.jsonc b/deno.jsonc index 6ca9a1e5f..fd00e40b9 100644 --- a/deno.jsonc +++ b/deno.jsonc @@ -33,6 +33,7 @@ "dnt": "deno task run _tasks/dnt.ts", "star": "deno task run _tasks/star.ts && deno cache --no-check=remote _star.ts", "lock": "deno task star --lock=lock.json --lock-write", + "lint": "deno lint", "test": "deno test -A --no-check=remote -L=info --ignore=target", "test:update": "deno task test -- -- --update", "mdbook:watch": "mdbook watch -o",