diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md new file mode 100644 index 0000000..10c82ce --- /dev/null +++ b/.github/CONTRIBUTING.md @@ -0,0 +1,48 @@ +### Submitting Pull Requests + +We'd love for you to contribute to our source code and to make this package even better than it is +today! Here are the guidelines we'd like you to follow: + + - [Issues and Bugs](#issue) + - [Feature Requests](#feature) + - [Coding Rules](#rules) + - [Commit Message Guidelines](#commit) + +## Found an Issue? + +If you find a bug in the source code or a mistake in the documentation, you can help us by +submitting an issue to our [GitHub Repository][github]. Even better you can submit a Pull Request +with a fix. But first search if the issue is already described! + +If not create a new issue: + +* Tell about your environment: + * java version + * used platform and version +* Describe your issue + * describe your steps leading to the issue + * attach error logs or screenshots + * if possible provide test case or screenshots + +## Want a Feature? + +You can request a new feature by submitting an issue to our [GitHub Repository][github]. + +Please follow these basic steps to simplify pull request reviews - if you don't you'll probably just be asked to anyway.** + +* Please rebase your branch against the current develop, use the **develop** for pull requests +* Please ensure that the test suite passes **and** that code is lint free before submitting a PR by running: + * ```./mvnw test``` +* If you've added new functionality, **please** include tests which validate its behaviour +* Make reference to possible [issues](https://github.com/ContinuousSecurityTooling/renovate-config/issues) on PR comment + +## Coding Rules + +To ensure consistency throughout the source code, keep these rules in mind as you are working: + +* All features or bug fixes **must be tested** by one or more [specs][unit-testing]. +* All public API methods **must be documented** with jsdoc. + +## Git Commit Guidelines + +We're using [Angular Commit Guidelines](https://github.com/angular/angular.js/blob/master/CONTRIBUTING.md#-git-commit-guidelines) diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml new file mode 100644 index 0000000..abba267 --- /dev/null +++ b/.github/FUNDING.yml @@ -0,0 +1,3 @@ +# These are supported funding model platforms +open_collective: m13t +github: ContinuousSecurityTooling \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..a8ed936 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,34 @@ +--- +name: Bug report +about: Create a report to help us improve + +--- +> ℹ Please fill out this template when filing an issue. +> All lines beginning with an ℹ symbol instruct you with what info we expect. You can delete those lines once you've filled in the info. +> +> Per our [*CONTRIBUTING guidelines](https://github.com/ContinuousSecurityTooling/renovate-config/CONTRIBUTING.md), we use GitHub for +> bugs and feature requests, not general support. Other issues should be opened on Stack Overflow with the tag `angular`. +> +> Please remove this line and everything above it before submitting. + +* [ ] I've read, understood, and done my best to follow the [*CONTRIBUTING guidelines](https://github.com/ContinuousSecurityTooling/renovate-config/CONTRIBUTING.md). + +## What did you do? + +ℹ Please replace this with what you did. + +## What did you expect to happen? + +ℹ Please replace this with what you expected to happen. + +## What happened instead? + +ℹ Please replace this with of what happened instead. + +## Your Environment + +**Java version:** + +## Demo Project + +ℹ Please link to or upload a project we can download that reproduces the issue. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..971d33e --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,25 @@ +--- +name: Feature request +about: Suggest an idea for this project + +--- + +## Prerequisites + +Please answer the following questions for yourself before submitting an issue. + +* [ ] I've read, understood, and done my best to follow the [*CONTRIBUTING guidelines](https://github.com/ContinuousSecurityTooling/renovate-config/CONTRIBUTING.md). + +## Changes + +**Is your feature request related to a problem? Please describe.** + + +**Describe the solution you'd like** + + +**Describe alternatives you've considered** + + +**Additional context** + diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..cf67524 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,35 @@ +## :memo: Description + + + +### :dart: Relevant issues + + +### :gem: Type of change + + + +- [ ] Bug fix (non-breaking change which fixes an issue) +- [ ] New feature (non-breaking change which adds functionality) +- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected) +- [ ] This change requires a documentation update + +### :scroll: Example code +```js + +``` + +## :vertical_traffic_light: How Has This Been Tested? + +Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration + +- [ ] Test A +- [ ] Test B + +## :checkered_flag: Checklist: + +- [ ] My code follows the style guidelines of this project +- [ ] I have performed a self-review of my own code +- [ ] **I have added tests that prove my fix is effective or that my feature works** +- [ ] **New and existing unit tests pass locally with my changes** +- [ ] I have commented my code, particularly in hard-to-understand areas diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml new file mode 100644 index 0000000..c16c26d --- /dev/null +++ b/.github/workflows/build.yml @@ -0,0 +1,13 @@ +name: CI + +on: + pull_request: + merge_group: + push: + +jobs: + validate: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v2 + - uses: suzuki-shunsuke/github-action-renovate-config-validator@v1.0.1