diff --git a/docs/content/contributing/_category_.yml b/docs/content/contributing/_category_.yml new file mode 100644 index 0000000..a86ae05 --- /dev/null +++ b/docs/content/contributing/_category_.yml @@ -0,0 +1,4 @@ +label: 'Contributing' +position: 99 +collapsible: true +collapsed: false diff --git a/docs/content/contributing/code-of-conduct.md b/docs/content/contributing/code-of-conduct.md new file mode 100644 index 0000000..a44fb36 --- /dev/null +++ b/docs/content/contributing/code-of-conduct.md @@ -0,0 +1,69 @@ +--- +id: code-of-conduct + +title: Code of Conduct + +sidebar_position: 2 +--- + +# 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, +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. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, +available at [http://contributor-covenant.org/version/1/4][version] + +[homepage]: http://contributor-covenant.org +[version]: http://contributor-covenant.org/version/1/4/ diff --git a/docs/content/contributing/commit-convention.md b/docs/content/contributing/commit-convention.md new file mode 100644 index 0000000..80cf861 --- /dev/null +++ b/docs/content/contributing/commit-convention.md @@ -0,0 +1,71 @@ +--- +id: commit-convention + +title: Commit convention + +sidebar_position: 3 +--- + +## Git Commit Message Convention + +:::info + +This is adapted from [Angular's commit convention](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-angular). + +::: + +#### TL;DR: + +Commit titles must match the following regex: + +```js +/^(revert: )?(feat|fix|docs|style|refactor|perf|test|workflow|build|ci|chore|types|wip)(\(.+\))?: .{1,72}/; +``` + +### Full Message Format + +A commit message consists of a **header**, **body** and **footer**. The header has a **type**, **scope** and **subject**: + +``` +(): + + + +