Skip to content

Commit

Permalink
Link to org-wide security policy and code of conduct
Browse files Browse the repository at this point in the history
  • Loading branch information
matteodelabre committed Jan 15, 2021
1 parent 22a156e commit 1486fb6
Show file tree
Hide file tree
Showing 3 changed files with 18 additions and 7 deletions.
3 changes: 3 additions & 0 deletions 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.
19 changes: 12 additions & 7 deletions docs/contributing.md
Expand Up @@ -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).

Expand All @@ -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).
Expand All @@ -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.
3 changes: 3 additions & 0 deletions 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.

0 comments on commit 1486fb6

Please sign in to comment.