From ba42cced11dc99b7cbf605c618e6eda713eaa5b7 Mon Sep 17 00:00:00 2001 From: Rabosa616 Date: Thu, 10 Aug 2023 09:10:41 +0200 Subject: [PATCH] Initial commit --- .all-contributorsrc | 14 ++ .github/CODEOWNERS | 1 + .github/ISSUE_TEMPLATE/10_bug_report.yml | 61 ++++++++ .github/ISSUE_TEMPLATE/20_feature_request.yml | 35 +++++ .github/ISSUE_TEMPLATE/30_design_proposal.yml | 45 ++++++ .github/PULL_REQUEST_TEMPLATE/servicing.md | 39 +++++ .github/config.yml | 21 +++ .github/pull_request_template.md | 21 +++ .github/workflows/SyncTemplateWithRepos.yml | 108 ++++++++++++++ AUTHORS.md | 11 ++ CODE_OF_CONDUCT.md | 133 ++++++++++++++++++ CONTRIBUTING.md | 115 +++++++++++++++ LICENSE | 22 +++ README.md | 86 +++++++++++ SECURITY.md | 39 +++++ sync.yml | 36 +++++ 16 files changed, 787 insertions(+) create mode 100644 .all-contributorsrc create mode 100644 .github/CODEOWNERS create mode 100644 .github/ISSUE_TEMPLATE/10_bug_report.yml create mode 100644 .github/ISSUE_TEMPLATE/20_feature_request.yml create mode 100644 .github/ISSUE_TEMPLATE/30_design_proposal.yml create mode 100644 .github/PULL_REQUEST_TEMPLATE/servicing.md create mode 100644 .github/config.yml create mode 100644 .github/pull_request_template.md create mode 100644 .github/workflows/SyncTemplateWithRepos.yml create mode 100644 AUTHORS.md create mode 100644 CODE_OF_CONDUCT.md create mode 100644 CONTRIBUTING.md create mode 100644 LICENSE create mode 100644 README.md create mode 100644 SECURITY.md create mode 100644 sync.yml diff --git a/.all-contributorsrc b/.all-contributorsrc new file mode 100644 index 0000000..f31d648 --- /dev/null +++ b/.all-contributorsrc @@ -0,0 +1,14 @@ +{ + "files": [ + "README.md" + ], + "imageSize": 100, + "commit": false, + "contributorsPerLine": 7, + "projectOwner": "ERNI-Academy", + "repoType": "github", + "repoHost": "https://github.com", + "skipCi": true, + "badgeTemplate": "[![All Contributors](https://img.shields.io/badge/all_contributors-<%= contributors.length %>-orange.svg?style=flat-square)](#contributors)", + "contributors": [] +} \ No newline at end of file diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS new file mode 100644 index 0000000..8a7209c --- /dev/null +++ b/.github/CODEOWNERS @@ -0,0 +1 @@ +* \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/10_bug_report.yml b/.github/ISSUE_TEMPLATE/10_bug_report.yml new file mode 100644 index 0000000..fce802d --- /dev/null +++ b/.github/ISSUE_TEMPLATE/10_bug_report.yml @@ -0,0 +1,61 @@ +name: 🐞 Bug Report +description: Create a report about something that is not working +body: +- type: markdown + attributes: + value: | + Please keep in mind that the GitHub issue tracker is not intended as a general support forum, but for reporting bugs and feature requests. + +- type: checkboxes + attributes: + label: Is there an existing issue for this? + description: Please search to see if an issue already exists for the bug you encountered. + options: + - label: I have searched the existing issues + required: true +- type: textarea + attributes: + label: Describe the bug + description: A clear and concise description of what the bug is. + validations: + required: true +- type: textarea + attributes: + label: Expected Behavior + description: A clear and concise description of what you expected to happen. + validations: + required: false +- type: textarea + attributes: + label: Steps To Reproduce + description: | + Steps to reproduce the behavior. + + We ❤ code! Point us to a minimalistic repro project hosted in a public GitHub repo. + For a repro project, create a new ASP.NET Core project using the template of your choice, apply the minimum required code to result in the issue you're observing. + + We will close this issue if: + - The repro project you share with us is complex. We can't investigate custom projects, so don't point us to such, please. + - If we will not be able to repro the behavior you're reporting. + - If the repro project is attached as a `.zip` file. + - If the GitHub repro project is set to `Private`. + validations: + required: false +- type: textarea + attributes: + label: Exceptions (if any) + description: Include the exception you get when facing this issue. + validations: + required: false +- type: textarea + attributes: + label: Anything else? + description: | + - version: + - The IDE (VS / VS Code/ VS4Mac) you're running on, and its version: + + Links? References? Anything that will give us more context about the issue you are encountering! + + Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in. + validations: + required: false \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/20_feature_request.yml b/.github/ISSUE_TEMPLATE/20_feature_request.yml new file mode 100644 index 0000000..abe9ead --- /dev/null +++ b/.github/ISSUE_TEMPLATE/20_feature_request.yml @@ -0,0 +1,35 @@ +name: 💡 Feature request +description: Suggest an idea for this project +body: +- type: markdown + attributes: + value: | + Please keep in mind that the GitHub issue tracker is not intended as a general support forum, but for reporting bugs and feature requests. +- type: checkboxes + attributes: + label: Is there an existing issue for this? + description: Please search to see if an issue already exists for the feature you are requesting. + options: + - label: I have searched the existing issues + required: true +- type: textarea + attributes: + label: Is your feature request related to a problem? Please describe the problem. + description: A clear and concise description of what the problem is. + placeholder: I am trying to do [...] but [...] + validations: + required: false +- type: textarea + attributes: + label: Describe the solution you'd like + description: | + A clear and concise description of what you want to happen. Include any alternative solutions you've considered. + validations: + required: true +- type: textarea + attributes: + label: Additional context + description: | + Add any other context or screenshots about the feature request here. + validations: + required: false \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/30_design_proposal.yml b/.github/ISSUE_TEMPLATE/30_design_proposal.yml new file mode 100644 index 0000000..5a13043 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/30_design_proposal.yml @@ -0,0 +1,45 @@ +name: 🤔 Design proposal +description: Collaborate on a design for a feature/fix or other change +labels: + - "design-proposal" +body: + - type: markdown + attributes: + value: | + Please keep in mind that the GitHub issue tracker is not intended as a general support forum, but for reporting bugs and feature requests. + - type: textarea + attributes: + label: Explain in 1-2 sentences. Say what this is about. + description: 1-2 sentences. Say what this is about. + validations: + required: true + - type: textarea + attributes: + label: Motivation Goals + description: 1-2 paragraphs, or a bullet-pointed list. What existing pain points does this solve? What evidence shows it's valuable to solve this? + validations: + required: true + - type: textarea + attributes: + label: In scope + description: A list of major scenarios, perhaps in priority order. + validations: + required: true + - type: textarea + attributes: + label: Out of scope + description: Scenarios you explicitly want to exclude. + validations: + required: true + - type: textarea + attributes: + label: Risks / unknowns + description: How might developers misinterpret/misuse this? How might implementing it restrict us from other enhancements in the future? Also list any perf/security/correctness concerns. + validations: + required: true + - type: textarea + attributes: + label: Examples + description: Give brief examples of possible developer experiences (e.g., code they would write). Don't be deeply concerned with how it would be implemented yet. Your examples could even be from other technology stacks. + validations: + required: false \ No newline at end of file diff --git a/.github/PULL_REQUEST_TEMPLATE/servicing.md b/.github/PULL_REQUEST_TEMPLATE/servicing.md new file mode 100644 index 0000000..8b5d0dc --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/servicing.md @@ -0,0 +1,39 @@ +# {PR title} + +Summary of the changes (Less than 80 chars) + +## Description + +{Detail} + +Fixes #{bug number} (in this specific format) + +## Customer Impact + +{Justification} + +## Regression? + +- [ ] Yes +- [ ] No + +[If yes, specify the version the behavior has regressed from] + +## Risk + +- [ ] High +- [ ] Medium +- [ ] Low + +[Justify the selection above] + +## Verification + +- [ ] Manual (required) +- [ ] Automated + +## Packaging changes reviewed? + +- [ ] Yes +- [ ] No +- [ ] N/A \ No newline at end of file diff --git a/.github/config.yml b/.github/config.yml new file mode 100644 index 0000000..9a61ea7 --- /dev/null +++ b/.github/config.yml @@ -0,0 +1,21 @@ +blank_issues_enabled: true + +# Configuration for welcome - https://github.com/behaviorbot/welcome + +# Configuration for new-issue-welcome - https://github.com/behaviorbot/new-issue-welcome + +# Comment to be posted to on first time issues +newIssueWelcomeComment: > + Thanks for opening your first issue here! Be sure to follow the issue template! +# Configuration for new-pr-welcome - https://github.com/behaviorbot/new-pr-welcome + +# Comment to be posted to on PRs from first time contributors in your repository +newPRWelcomeComment: > + Thanks for opening this pull request! If you haven't already, please be sure to check out [the contributing guidelines](https://github.com/ERNI-Academy/erni-academy-template/blob/main/CONTRIBUTING.md). +# Configuration for first-pr-merge - https://github.com/behaviorbot/first-pr-merge + +# Comment to be posted to on pull requests merged by a first time user +firstPRMergeComment: > + Congrats on merging your first pull request!

We here at Erni-Academy are proud of you! :tada:

If you're interested in tackling another bug or feature, take a look at the open issues, especially those labeled `help wanted`." + +# It is recommend to include as many gifs and emojis as possible \ No newline at end of file diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..a0bb7ed --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,21 @@ +# {PR title} + + + + + +- [ ] You've read the [Contributor Guide](./../CONTRIBUTING.md) and [Code of Conduct](./../CODE-OF-CONDUCT.md). +- [ ] You've included unit or integration tests for your change, where applicable. +- [ ] You've included inline docs for your change, where applicable. +- [ ] There's an open issue for the PR that you are making. If you'd like to propose a new feature or change, please open an issue to discuss the change or find an existing issue. + + + +Summary of the changes (Less than 80 chars) + +## Description + +{Detail} + +Fixes #{bug number} (in this specific format) \ No newline at end of file diff --git a/.github/workflows/SyncTemplateWithRepos.yml b/.github/workflows/SyncTemplateWithRepos.yml new file mode 100644 index 0000000..0f16cb2 --- /dev/null +++ b/.github/workflows/SyncTemplateWithRepos.yml @@ -0,0 +1,108 @@ +name: Sync Template files to repositories +on: # rebuild any PRs and main branch changes + push: + branches: + - main + workflow_call: + secrets: + REPOS_ACCESS_TOKEN: + required: true +jobs: + # Run cleaning process only if workflow is triggered by the non-ERNI-Academy/erni-academy-template repository. + template-cleanup: + name: Template Cleanup + runs-on: ubuntu-latest + if: github.event.repository.name != 'erni-academy-template' + steps: + # Check out current repository + - name: Checkout + uses: actions/checkout@v3 + + # Cleanup project + - name: Cleanup + run: | + # Cleanup + rm -rf \ + sync.yml \ + .github/workflows/SyncTemplateWithRepos.yml \ + # Commit modified files + - name: Commit files + run: | + git config --local user.email "action@github.com" + git config --local user.name "GitHub Action" + git add . + git commit -m "🗑️ Template cleanup" + + # Push changes + - name: Push changes + uses: ad-m/github-push-action@master + with: + branch: main + github_token: ${{ secrets.GITHUB_TOKEN }} + + generate_list_of_repos: + if: github.event.repository.name == 'erni-academy-template' + runs-on: ubuntu-latest + outputs: + repos: ${{ steps.generate-matrix.outputs.repos}} + matrix: ${{ steps.generate-matrix.outputs.matrix}} + steps: + - name: Generate Matrix + id: generate-matrix + run: | + REPOSITORIES=`curl https://api.github.com/orgs/ERNI-Academy/repos?per_page=200 -H "Accept: application/json" -H "Bearer ${{ secrets.REPOS_ACCESS_TOKEN }}" | jq '.[].name'` + echo $REPOSITORIES + REPOSITORIES_FOR_JSON=`echo $REPOSITORIES | sed 's/ /},{\"repo\":/g'` + echo $REPOSITORIES_FOR_JSON + REPOSITORIES_FOR_JSON="{\"include\":[{\"repo\":$REPOSITORIES_FOR_JSON}]}" + echo $REPOSITORIES_FOR_JSON + REPOSITORIES_FOR_JSON="{\"include\":[{\"repo\":\"Test_Sync_Repo\"}]}" + echo ::set-output name=matrix::$JSON_REPOS + + REPOSITORIES=`echo $REPOSITORIES | sed 's/\".github\" //g'` + REPOSITORIES_FOR_LIST=`echo $REPOSITORIES | sed 's/\" \"/\n ERNI-Academy\//g'` + REPOSITORIES_FOR_LIST=`echo $REPOSITORIES_FOR_LIST | sed 's/\"//g'` + REPOSITORIES_FOR_LIST="ERNI-Academy/$REPOSITORIES_FOR_LIST" + REPOSITORIES_FOR_LIST="\"$REPOSITORIES_FOR_LIST\"" + echo $REPOSITORIES_FOR_LIST + echo ::set-output name=repos::$REPOSITORIES_FOR_LIST + shell: bash + + propagate_changes_to_repos: + if: github.event.repository.name == 'erni-academy-template' + needs: generate_list_of_repos + runs-on: ubuntu-latest + steps: + - run: echo ${{ matrix.repo }} + - name: Checkout + uses: actions/checkout@v3 + - name: Create Configuration File + id: create_configuration_file + shell: bash + run: | + echo ${{ needs.generate_list_of_repos.outputs.repos }} + value=$(> sync.yml; done + + # sed -i "s/Repositories/${newstr}/g" sync.yml + value_new=$(``` + +- *ERNI*. your_name [@your_github](https://github.com/your_github) \ No newline at end of file diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..3c80261 --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,133 @@ + +# 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 +[esp-services@betterask.erni](mailto:esp-services@betterask.erni). +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][v2.0]. + +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.0]: https://www.contributor-covenant.org/version/2/0/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 \ No newline at end of file diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..3e5142f --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,115 @@ +[code_of_conduct]: ./CODE_OF_CONDUCT.md +[repo_from_template]: https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/creating-a-repository-from-a-template +[fork]: https://docs.github.com/en/github/getting-started-with-github/fork-a-repo +[clone]: https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/cloning-a-repository +[push]: https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/merging-an-upstream-repository-into-your-fork +[pull]: https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/allowing-changes-to-a-pull-request-branch-created-from-a-fork +[template]: https://github.com/ERNI-Academy/erni-academy-template + +# Contributing + +This document is a set of guidelines for contributing to this repository. + +- [Contributing](#contributing) + - [Getting started](#getting-started) + - [1. How to become a contributor](#1-how-to-become-a-contributor) + - [2. How to create a resource](#2-how-to-create-a-resource) + - [3. How to contribute](#3-how-to-contribute) + - [Code of Conduct](#code-of-conduct) + +## Getting started + +Please note that this project is released with a Contributor [Code of Conduct][code_of_conduct]. By participating in this project you agree to abide by its terms. + +All contributions, however small are valued! + +If you have an idea to share in the form of Proof of concept, Starterkit or Guideline become a contributor and collaborate with us. + +## 1. How to become a contributor + +Before starting you must be a ERNI contributor. + +Please send us an email to this account so we can add you to our contributors list. + +📧 + +## 2. How to create a resource + +Create your reposoitory from ERNI Academy Template: + +Use this guide [Creating a repository from a template][repo_from_template] to create your repository from ["erni-academy-template"][template]. + +Please, pay attention to the new repository name and follow this simple schema: + +**{type}-{learningPath}-{description}**\. + +| Type | desc | +|------------|------------------| +| poc | proof of concept | +| starterkit | Starter Kit | +| guideline | Guideline | +| asset | Asset | +| framework | Framework | +| training | Training | +| action | Github Action | + +**Examples:** + +- poc-frontend-start-with-angular +- starterkit-backend-net-api +- guideline-devops-pipelines + +## 3. How to contribute + +Whether you want to contribute to your new repository or you want to update ERNI awesome resource list the process is the same: + +1. [**Fork the repository**][fork] to your personal Github. Forking is basically an easy way to make a duplicate of the repository to your own account. +2. [**Clone**][clone] the project to your own machine. + + ```sh + # Clone your fork of the repo into the current directory + git clone https://github.com// + # Navigate to the newly cloned directory + cd + # Assign the original repo to a remote called "upstream" + git remote add upstream https://github.com// + ``` + +3. If you cloned a while ago, get the **latest changes** from upstream. + + ```sh + git checkout + git pull upstream + ``` + +4. Create a new **topic branch** (off the main project development branch) to contain your feature, change, or fix. + + ```sh + git checkout -b + ``` + +5. **Commit** changes to your own branch. + + ```sh + git commit -m 'Add some feature' + ``` + +6. **Locally merge** (or rebase) the upstream development branch into your topic branch. + + ```sh + git pull [--rebase] upstream + ``` + +7. [**Push**][push] your topic branch up to your fork. + + ```sh + git push origin + ``` + +8. Open a [**Pull Request**][pull] with a clear title and description so that we can review your changes. + +Thanks for your interest in contributing to this repository. + +## Code of Conduct + +This project follows a [Code of Conduct][code_of_conduct] in order to ensure an open and welcoming environment. diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..08dd970 --- /dev/null +++ b/LICENSE @@ -0,0 +1,22 @@ +MIT License + +Copyright (c) 2022 ERNI + +Permission is hereby granted, free of charge, to any person obtaining +a copy of this software and associated documentation files (the +"Software"), to deal in the Software without restriction, including +without limitation the rights to use, copy, modify, merge, publish, +distribute, sublicense, and/or sell copies of the Software, and to +permit persons to whom the Software is furnished to do so, subject to +the following conditions: + +The above copyright notice and this permission notice shall be +included in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, +EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF +MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND +NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE +LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION +OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION +WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. diff --git a/README.md b/README.md new file mode 100644 index 0000000..50cd967 --- /dev/null +++ b/README.md @@ -0,0 +1,86 @@ +# About {{ Name }} + +ERNI Academy StarterKit, PoC, or Gidelines. This is an about description of your repository. + + + + +## Built With + +This section should list any major frameworks that you built your project using. Leave any add-ons/plugins for the acknowledgements section. Here are a few examples. + +- [Tools A](https://example.com) +- [Framework B](https://example.com) +- [Project C](https://example.com) + +## Features + +- Be awesome +- Make things faster + +## Getting Started + +This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps. + +## Prerequisites + +This is an example of how to list things you need to use the software and how to install them. + +## Installation + +Installation instructions {{ Name }} by running: + +1. Clone the repo + + ```sh + git clone https://github.com/ERNI-Academy/Project-Name.git + ``` + +2. Install packages + + ```sh + npm install + ``` + +3. Configure + + ```JS + const API_KEY = 'ENTER YOUR API'; + ``` + +## Contributing + +Please see our [Contribution Guide](CONTRIBUTING.md) to learn how to contribute. + +## License + +![MIT](https://img.shields.io/badge/License-MIT-blue.svg) + +(LICENSE) © {{Year}} [ERNI - Swiss Software Engineering](https://www.betterask.erni) + +## Code of conduct + +Please see our [Code of Conduct](CODE_OF_CONDUCT.md) + +## Stats + +Check [https://repobeats.axiom.co/](https://repobeats.axiom.co/) for the right URL + +## Follow us + +[![Twitter Follow](https://img.shields.io/twitter/follow/ERNI?style=social)](https://www.twitter.com/ERNI) +[![Twitch Status](https://img.shields.io/twitch/status/erni_academy?label=Twitch%20Erni%20Academy&style=social)](https://www.twitch.tv/erni_academy) +[![YouTube Channel Views](https://img.shields.io/youtube/channel/views/UCkdDcxjml85-Ydn7Dc577WQ?label=Youtube%20Erni%20Academy&style=social)](https://www.youtube.com/channel/UCkdDcxjml85-Ydn7Dc577WQ) +[![Linkedin](https://img.shields.io/badge/linkedin-31k-green?style=social&logo=Linkedin)](https://www.linkedin.com/company/erni) + +## Contact + +📧 [esp-services@betterask.erni](mailto:esp-services@betterask.erni) + +## Contributors ✨ + +Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)): + + + +This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome! diff --git a/SECURITY.md b/SECURITY.md new file mode 100644 index 0000000..7eb8e83 --- /dev/null +++ b/SECURITY.md @@ -0,0 +1,39 @@ +# ERNI-Academy Open Source Security Policies and Procedures + +This document outlines security procedures and general policies for the +ERNI Accademy Open Source projects as found on . + +- [ERNI-Academy Open Source Security Policies and Procedures](#erni-academy-open-source-security-policies-and-procedures) + - [Reporting a Vulnerability](#reporting-a-vulnerability) + - [Disclosure Policy](#disclosure-policy) + +## Reporting a Vulnerability + +The ERNI-Academy OSS team and community take all security vulnerabilities +seriously. Thank you for improving the security of our open source +software. We appreciate your efforts and responsible disclosure and will +make every effort to acknowledge your contributions. + +Report security vulnerabilities by emailing the ERNI-Academy security team at: + + academy@betterask.erni + +The lead maintainer will acknowledge your email, and will +send a more detailed response indicating the next steps in +handling your report. After the initial reply to your report, the security +team will endeavor to keep you informed of the progress towards a fix and +full announcement, and may ask for additional information or guidance. + +Report security vulnerabilities in third-party modules to the person or +team maintaining the module. + +## Disclosure Policy + +When the security team receives a security bug report, they will assign it +to a primary handler. This person will coordinate the fix and release +process, involving the following steps: + +* Confirm the problem and determine the affected versions. +* Audit code to find any potential similar problems. +* Prepare fixes for all releases still under maintenance. These fixes + will be released as fast as possible. diff --git a/sync.yml b/sync.yml new file mode 100644 index 0000000..46a9293 --- /dev/null +++ b/sync.yml @@ -0,0 +1,36 @@ +group: + # dependabot workflow + - files: + - source: .all-contributorsrc + dest: .all-contributorsrc + replace: false + - source: AUTHORS.md + dest: AUTHORS.md + replace: false + - source: README.md + dest: README.md + replace: false + + - source: CODE_OF_CONDUCT.md + dest: CODE_OF_CONDUCT.md + - source: CONTRIBUTING.md + dest: CONTRIBUTING.md + - source: SECURITY.md + dest: SECURITY.md + + - source: .github/ISSUE_TEMPLATE/ + dest: .github/ISSUE_TEMPLATE/ + - source: .github/PULL_REQUEST_TEMPLATE/ + dest: .github/PULL_REQUEST_TEMPLATE/ + + - source: .github/CODEOWNERS + dest: .github/CODEOWNERS + replace: false + - source: .github/config.yml + dest: .github/config.yml + replace: false + - source: .github/pull_request_template.md + # LICENSE + - source: LICENSE + dest: LICENSE + repos: |