From df4ba69ec3894b06aabb5318eefbed538350aabd Mon Sep 17 00:00:00 2001 From: CI Friends Date: Thu, 16 May 2024 06:49:36 +0000 Subject: [PATCH 1/7] chore: process 1 PRP files --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 005e6bb..d12038d 100644 --- a/README.md +++ b/README.md @@ -32,7 +32,7 @@ use it: ```yml steps: - name: PRP Preprocessor - uses: CIFriends/prp-preprocessor@vmain + uses: CIFriends/prp-preprocessor@vdev with: rootDir: './example' ``` From 4eb89744c98dd5f960e808a7a715aaec78edb607 Mon Sep 17 00:00:00 2001 From: Breno A Date: Thu, 16 May 2024 03:55:51 -0300 Subject: [PATCH 2/7] chore: add dev branch info --- CONTRIBUTING.md | 15 ++++++++++++--- 1 file changed, 12 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 60303d0..73bdcce 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -5,13 +5,22 @@ email, or any other method with the owners of this repository before making a ch Please note we have a [code of conduct](CODE_OF_CONDUCT.md), please follow it in all your interactions with the project. +## Branching Strategy + +We use a simple branching strategy. +The `main` branch is the production branch, and the `dev` branch is the development branch. +All the development goes on in the `dev` branch. +If you're contributing, please create a new branch off `dev`. + ## Pull Request Process -1. Ensure any install or build dependencies are removed before the end of the layer when doing a +1. Ensure any installation or build dependencies are removed before the end of the layer when doing a build. -2. Update the README.md with details of changes to the interface, this includes new environment +2. Update the `readme.prp.md` or Wiki with details of changes to the interface, this includes new environment variables, exposed ports, useful file locations and container parameters. -3. Increase the version numbers in any examples files and the README.md to the new version that this +3. Increase the version numbers in any examples files and the `prp` file to the new version that this Pull Request would represent. The versioning scheme we use is [SemVer](http://semver.org/). 4. You may merge the Pull Request in once you have the sign-off of two other developers, or if you do not have permission to do that, you may request the second reviewer to merge it for you. + +Remember to always create a new branch for your work and open a pull request against the `dev` branch when you're ready. From 585b12a53e0a1cebf4f843fe82b3b22260dc8861 Mon Sep 17 00:00:00 2001 From: Breno A Date: Thu, 16 May 2024 03:58:15 -0300 Subject: [PATCH 3/7] chore: add contributing to README.prp.md --- README.prp.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/README.prp.md b/README.prp.md index f039ba5..590fefd 100644 --- a/README.prp.md +++ b/README.prp.md @@ -31,7 +31,7 @@ use it: ```yml steps: - name: PRP Preprocessor - uses: CIFriends/prp-preprocessor@v{_currentVersion_} + uses: CIFriends/prp-preprocessor@{_currentVersion_} with: rootDir: './example' ``` @@ -40,7 +40,9 @@ steps: Inputs can be found at [here](https://github.com/CIFriends/prp-preprocessor/wiki/Inputs). -## Show your support +## Contributing + +We welcome contributions to this project! Please read our [Contributing Guide](CONTRIBUTING.md) for more information on how to contribute. If you've found this project useful, please consider giving it a ⭐ on GitHub. This helps to spread the awareness of the project and is a great way to show your support! From 7a99e8e0ad73fd244e281242cc42091e5570e9f1 Mon Sep 17 00:00:00 2001 From: Breno A Date: Thu, 16 May 2024 03:59:26 -0300 Subject: [PATCH 4/7] chore: Create CODE_OF_CONDUCT.md --- CODE_OF_CONDUCT.md | 128 +++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 128 insertions(+) create mode 100644 CODE_OF_CONDUCT.md diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..5b70cee --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,128 @@ +# 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, 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 +git@breno.tech. +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.0, available at +https://www.contributor-covenant.org/version/2/0/code_of_conduct.html. + +Community Impact Guidelines were inspired by [Mozilla's code of conduct +enforcement ladder](https://github.com/mozilla/diversity). + +[homepage]: https://www.contributor-covenant.org + +For answers to common questions about this code of conduct, see the FAQ at +https://www.contributor-covenant.org/faq. Translations are available at +https://www.contributor-covenant.org/translations. From 303e0ffdec05fbbe4859b0f0d8659d2e5771d24c Mon Sep 17 00:00:00 2001 From: Breno A Date: Thu, 16 May 2024 04:04:44 -0300 Subject: [PATCH 5/7] chore: Update issue templates --- .github/ISSUE_TEMPLATE/bug_report.md | 38 +++++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 20 ++++++++++++ 2 files changed, 58 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..dd84ea7 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,38 @@ +--- +name: Bug report +about: Create a report to help us improve +title: '' +labels: '' +assignees: '' + +--- + +**Describe the bug** +A clear and concise description of what the bug is. + +**To Reproduce** +Steps to reproduce the behavior: +1. Go to '...' +2. Click on '....' +3. Scroll down to '....' +4. See error + +**Expected behavior** +A clear and concise description of what you expected to happen. + +**Screenshots** +If applicable, add screenshots to help explain your problem. + +**Desktop (please complete the following information):** + - OS: [e.g. iOS] + - Browser [e.g. chrome, safari] + - Version [e.g. 22] + +**Smartphone (please complete the following information):** + - Device: [e.g. iPhone6] + - OS: [e.g. iOS8.1] + - Browser [e.g. stock browser, safari] + - Version [e.g. 22] + +**Additional context** +Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..bbcbbe7 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,20 @@ +--- +name: Feature request +about: Suggest an idea for this project +title: '' +labels: '' +assignees: '' + +--- + +**Is your feature request related to a problem? Please describe.** +A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] + +**Describe the solution you'd like** +A clear and concise description of what you want to happen. + +**Describe alternatives you've considered** +A clear and concise description of any alternative solutions or features you've considered. + +**Additional context** +Add any other context or screenshots about the feature request here. From cf8a53a7bf77fbe55d68fe531b514156bab1f2e2 Mon Sep 17 00:00:00 2001 From: Breno A Date: Thu, 16 May 2024 04:10:09 -0300 Subject: [PATCH 6/7] chore: Create SECURITY.md --- SECURITY.md | 11 +++++++++++ 1 file changed, 11 insertions(+) create mode 100644 SECURITY.md diff --git a/SECURITY.md b/SECURITY.md new file mode 100644 index 0000000..f1cbb1e --- /dev/null +++ b/SECURITY.md @@ -0,0 +1,11 @@ +# Security Policy + +## Reporting a Vulnerability + +To report a vulnerability, please use the "Security" tab in our GitHub repository. +If you are not comfortable with disclosing the issue publicly, you can email us at git@breno.tech. + +We will try to respond to your report within 48 hours and will keep you updated about the progress of resolving the issue. +Please understand that the resolution process might take some time depending on the complexity of the issue. + +If the reported issue is confirmed as a vulnerability, we will work on a fix and plan a release. We will also acknowledge your contribution in the release notes. From 27ef9a9d6502da5a7e6dd8bc64f513b0ceab94cd Mon Sep 17 00:00:00 2001 From: CI Friends Date: Thu, 16 May 2024 07:10:54 +0000 Subject: [PATCH 7/7] chore: process 1 PRP files --- README.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index d12038d..f960485 100644 --- a/README.md +++ b/README.md @@ -32,7 +32,7 @@ use it: ```yml steps: - name: PRP Preprocessor - uses: CIFriends/prp-preprocessor@vdev + uses: CIFriends/prp-preprocessor@dev with: rootDir: './example' ``` @@ -41,7 +41,9 @@ steps: Inputs can be found at [here](https://github.com/CIFriends/prp-preprocessor/wiki/Inputs). -## Show your support +## Contributing + +We welcome contributions to this project! Please read our [Contributing Guide](CONTRIBUTING.md) for more information on how to contribute. If you've found this project useful, please consider giving it a ⭐ on GitHub. This helps to spread the awareness of the project and is a great way to show your support!