diff --git a/docs/code_of_conduct.md b/docs/code_of_conduct.md new file mode 100644 index 000000000..2608484b6 --- /dev/null +++ b/docs/code_of_conduct.md @@ -0,0 +1,3 @@ +## Code of Conduct + +Please see [the Toltec organization](https://github.com/toltec-dev/organization/blob/main/docs/code_of_conduct.md)’s code of conduct document. diff --git a/docs/contributing.md b/docs/contributing.md index cd73746cf..4efc9988c 100644 --- a/docs/contributing.md +++ b/docs/contributing.md @@ -11,17 +11,17 @@ To directly propose changes, the basic procedure is to fork this repository, mak When proposing changes, please make sure that you follow the [style guide](#style-guide). After you submit your pull request, a maintainer will take time to review your changes, request modifications and then merge your changes into the repository if they fit. -### Common contributions +### Common Contributions -#### Requesting a package +#### Requesting a Package **TODO** -#### Reporting a bug +#### Reporting a Bug **TODO** -#### Adding a new package +#### Adding a New Package See [instructions for creating a package recipe](package.md). @@ -33,15 +33,15 @@ See [instructions for creating a package recipe](package.md). * for new packages, submit a pull request with the title: [$PACKAGE][$VERSION] - New Package * for updating packages, submit a pull request with the title: [$PACKAGE][$VERSION] - Updated Package -#### Upgrading a package +#### Upgrading a Package **TODO** -#### Improving the documentation +#### Improving the Documentation **TODO** -### Style guide +### Style Guide All contributions must follow the project’s [style guide](../.editorconfig). Shell scripts must also comply to [Shellcheck](https://github.com/koalaman/shellcheck). @@ -53,6 +53,11 @@ You may also check it manually by running `make format` (or `make format-fix` to Compliance of shell scripts to Shellcheck will also automatically be checked. To check it manually, run `make lint` at the root of the repository (you need to have Shellcheck installed on your computer for this to work). +### Code of Conduct + +Please note that this project is released with a [Contributor Code of Conduct](docs/code_of_conduct.md). +By participating in this project you agree to abide by its terms. + ### License By contributing to Toltec, you agree to place your contributions under the MIT license. diff --git a/docs/security.md b/docs/security.md new file mode 100644 index 000000000..3295a3198 --- /dev/null +++ b/docs/security.md @@ -0,0 +1,3 @@ +## Security Policy + +Please see [the Toltec organization](https://github.com/toltec-dev/organization/blob/main/docs/security.md)’s security policy.