-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
0144d52
commit 4eda641
Showing
10 changed files
with
372 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,36 @@ | ||
--- | ||
name: Bug report | ||
about: Report a bug to improve this project | ||
title: '' | ||
labels: '' | ||
assignees: '' | ||
|
||
--- | ||
|
||
#### The bug | ||
|
||
A clear and concise description of what the bug is. | ||
|
||
#### Software versions | ||
|
||
A list of software versions where the bug is apparent, as detailed as possible: | ||
|
||
* Erlang/OTP: ... | ||
* `simpler_cowboy_rest`: ... | ||
* other (where applicable): ... | ||
|
||
#### How to replicate | ||
|
||
An ordered list of steps to replicate the bug: | ||
|
||
1. run `rebar3 ci` | ||
2. search for `...` in the error output | ||
3. look at file `...` | ||
|
||
#### Expected behaviour | ||
|
||
What's expected to happen when you follow the steps listed above. | ||
|
||
#### Additional context | ||
|
||
Any other context about the bug. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,26 @@ | ||
--- | ||
name: Feature request | ||
about: Request a feature for this project | ||
title: '' | ||
labels: '' | ||
assignees: '' | ||
|
||
--- | ||
|
||
#### Is your feature request related to a problem? | ||
|
||
A clear and concise description of what the problem is, e.g. "I'm always frustrated | ||
when ..." | ||
|
||
#### Describe the feature you'd like | ||
|
||
A clear and concise description of what you want to happen after the new feature | ||
is implemented. | ||
|
||
#### Describe alternatives you've considered | ||
|
||
A clear and concise description of any alternative solutions or features you've considered. | ||
|
||
#### Additional context | ||
|
||
Any other context about the feature request. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
# Description | ||
|
||
A brief description of your changes. | ||
|
||
Closes #<issue>. | ||
|
||
- [ ] I have performed a self-review of my changes | ||
- [ ] I have read and understood the [contributing guidelines](/paulo-ferraz-oliveira/simpler_cowboy_rest/blob/main/CONTRIBUTING.md) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,43 @@ | ||
--- | ||
name: Lint | ||
|
||
on: | ||
push: | ||
branches: | ||
- main | ||
pull_request: | ||
branches: | ||
- "*" | ||
workflow_dispatch: {} | ||
|
||
jobs: | ||
lint: | ||
name: Lint | ||
|
||
runs-on: ubuntu-24.04 | ||
|
||
steps: | ||
- uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7 | ||
|
||
# uses .markdownlint.yml for configuration | ||
- name: markdownlint | ||
uses: DavidAnson/markdownlint-cli2-action@b4c9feab76d8025d1e83c653fa3990936df0e6c8 # v16.0.0 | ||
with: | ||
globs: | | ||
.github/**/*.md | ||
*.md | ||
example/*.md | ||
- name: yamllint | ||
uses: ibiqlik/action-yamllint@2576378a8e339169678f9939646ee3ee325e845c # v3.1.1 | ||
with: | ||
file_or_dir: | | ||
.github/**/*.yml | ||
.*.yml | ||
strict: true | ||
config_file: .yamllint.yml | ||
|
||
- name: actionlint | ||
uses: reviewdog/action-actionlint@afad3b6ab835e5611bda8c8193377e2d5c21413d # v1.51.0 | ||
env: | ||
SHELLCHECK_OPTS: -o all |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
--- | ||
default: true | ||
MD013: | ||
line_length: 100 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
--- | ||
extends: default | ||
rules: | ||
line-length: | ||
max: 100 | ||
truthy: disable | ||
comments: | ||
min-spaces-from-content: 1 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
# Changelog | ||
|
||
See the [Releases](https://github.com/paulo-ferraz-oliveira/simpler-cowboy-rest/releases) page. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 email 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 | ||
[INSERT CONTACT METHOD]. | ||
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 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,78 @@ | ||
# Contributing to `simpler_cowboy_rest` | ||
|
||
1. [License](#license) | ||
1. [Reporting a bug](#reporting-a-bug) | ||
1. [Requesting or implementing a feature](#requesting-or-implementing-a-feature) | ||
1. [Submitting your changes](#submitting-your-changes) | ||
1. [Code Style](#code-style) | ||
1. [Committing your changes](#committing-your-changes) | ||
1. [Pull requests and branching](#pull-requests-and-branching) | ||
1. [Credits](#credits) | ||
|
||
## License | ||
|
||
`simpler_cowboy_rest` is licensed under The [MIT](LICENSE.md) License, for all code. | ||
|
||
## Reporting a bug | ||
|
||
`simpler_cowboy_rest` is not perfect software and will be buggy. | ||
|
||
Bugs can be reported via | ||
[GitHub issues: bug report](https://github.com/paulo-ferraz-oliveira/simpler_cowboy_rest/issues/new?template=bug_report.md). | ||
|
||
Some contributors and maintainers may be unpaid developers working on `simpler_cowboy_rest`, in | ||
their own time, with limited resources. We ask for respect and understanding, and will provide the | ||
same back. | ||
|
||
If your contribution is an actual bug fix, we ask you to include tests that, not only show the issue | ||
is solved, but help prevent future regressions related to it. | ||
|
||
## Requesting or implementing a feature | ||
|
||
Before requesting or implementing a new feature, do the following: | ||
|
||
- search, in existing [issues](https://github.com/paulo-ferraz-oliveira/simpler_cowboy_rest/issues) | ||
(open or closed), whether | ||
the feature might already be in the works, or has already been rejected, | ||
- make sure you're using the latest software release (or even the latest code, if you're going for | ||
_bleeding edge_). | ||
|
||
If this is done, open up a | ||
[GitHub issues: feature request](https://github.com/paulo-ferraz-oliveira/simpler_cowboy_rest/issues/new?template=feature_request.md). | ||
|
||
We may discuss details with you regarding the implementation, and its inclusion within the project. | ||
|
||
We try to have as many of `simpler_cowboy_rest`' features tested as possible. Everything that a | ||
user can do, | ||
and is repeatable in any way, should be tested, to guarantee backwards compatible. | ||
|
||
## Submitting your changes | ||
|
||
### Code Style | ||
|
||
- do not introduce trailing whitespace | ||
- indentation is 4 spaces, not tabs | ||
- try not to introduce lines longer than 100 characters | ||
- write small functions whenever possible, and use descriptive names for functions and variables | ||
- comment tricky or non-obvious decisions made to explain their rationale | ||
|
||
### Committing your changes | ||
|
||
Merging to the `main` branch will usually be preceded by a squash. | ||
|
||
While it's Ok (and expected) your commit messages relate to why a given change was made, be aware | ||
that the final commit (the merge one) will be the issue title, so it's important it is as specific | ||
as possible. This will also help eventual automated changelog generation. | ||
|
||
### Pull requests and branching | ||
|
||
All fixes to `simpler_cowboy_rest` end up requiring a +1 from one or more of the project's maintainers. | ||
|
||
During the review process, you may be asked to correct or edit a few things before a final rebase | ||
to merge things. Do send edits as individual commits to allow for gradual and partial reviews to be | ||
done by reviewers. | ||
|
||
### Credits | ||
|
||
`simpler_cowboy_rest` has been improved by | ||
[many contributors](https://github.com/paulo-ferraz-oliveira/simpler_cowboy_rest/graphs/contributors)! |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,34 @@ | ||
# Security policy | ||
|
||
Thanks for helping make `simpler_cowboy_rest` safer for everyone. | ||
|
||
Find below updated information on our security policy. | ||
|
||
## Security | ||
|
||
We take the security of this software seriously. | ||
|
||
We don't implement a bug bounty program or bounty rewards, but will work with | ||
you to ensure that your findings get the appropriate handling. | ||
|
||
## Reporting Security Issues | ||
|
||
If you believe you have found a security vulnerability in this repository, | ||
please report it to <[email protected]>. | ||
|
||
Please do not report security vulnerabilities through public channels, like | ||
GitHub issues, discussions, or pull requests. | ||
|
||
Please include as much of the information listed below as you can to help us | ||
better understand and resolve the issue: | ||
|
||
- the type of issue (e.g., buffer overflow, SQL injection, or cross-site | ||
scripting) | ||
- full paths of source file(s) related to the manifestation of the issue | ||
- the location of the affected source code (tag/branch/commit or direct URL) | ||
- any special configuration required to reproduce the issue | ||
- step-by-step instructions to reproduce the issue | ||
- proof-of-concept or exploit code (if possible) | ||
- impact of the issue, including how an attacker might exploit the issue | ||
|
||
This information will help us triage your report more quickly. |