-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore(template): merge template changes 🆙
Signed-off-by: HoleInOneGolfer <[email protected]>
- Loading branch information
HoleInOneGolfer
committed
Sep 1, 2024
1 parent
342c76b
commit 931ba33
Showing
16 changed files
with
199 additions
and
131 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
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 |
---|---|---|
@@ -1 +1,46 @@ | ||
# Contributing guide | ||
# Contributing to This Project | ||
|
||
Thank you for considering contributing! Here are some guidelines to help you get started. | ||
|
||
## Code of Conduct | ||
|
||
Please note that this project adheres to a [Code of Conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. | ||
|
||
## How Can I Contribute? | ||
|
||
### Reporting Bugs | ||
|
||
If you find a bug, please open an issue with a detailed description of the problem and steps to reproduce it. | ||
|
||
### Suggesting Enhancements | ||
|
||
Enhancement suggestions are welcome! Please open an issue to discuss the suggestion before implementing it. | ||
|
||
### Submitting Pull Requests | ||
|
||
1. Fork the repository. | ||
2. Create a new branch for your feature or bugfix. | ||
3. Make your changes. | ||
4. Ensure the changes adhere to the project's coding standards. | ||
5. Commit your changes with a clear message. | ||
6. Push your branch to your fork. | ||
7. Open a pull request against the main branch of the original repository. | ||
|
||
## Style Guides | ||
|
||
### Coding Standards | ||
|
||
- Write clear, concise, and well-documented code. | ||
- Follow existing code patterns and styles. | ||
|
||
### Commit Messages | ||
|
||
- Use the imperative mood in the subject lines | ||
- Provide a detailed description of the change. | ||
|
||
*Or don't, but you will need to be available to answers any questions.* | ||
|
||
## Additional Notes | ||
|
||
- Issues and pull requests will be reviewed as soon as possible. | ||
- Please be patient and respectful to maintain a positive environment. |
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
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,7 @@ | ||
--- | ||
name: Custom issue template | ||
about: Describe this issue template's purpose here. | ||
title: 'Custom Issue' | ||
labels: '' | ||
assignees: '' | ||
--- |
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
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 |
---|---|---|
@@ -1 +1,3 @@ | ||
# Pull Request Template | ||
## Description | ||
|
||
Please provide a brief summary of the changes and the related issue. Try to provide as much information as possible. |
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 |
---|---|---|
@@ -1,21 +1,13 @@ | ||
# Security Policy | ||
|
||
## Supported Versions | ||
|
||
Use this section to tell people about which versions of your project are | ||
currently being supported with security updates. | ||
## Reporting a Vulnerability | ||
|
||
| Version | Supported | | ||
| ------- | ------------------ | | ||
| 5.1.x | :white_check_mark: | | ||
| 5.0.x | :x: | | ||
| 4.0.x | :white_check_mark: | | ||
| < 4.0 | :x: | | ||
If you discover a security vulnerability, please follow these steps: | ||
|
||
## Reporting a Vulnerability | ||
1. **Do not disclose it publicly** until we have had a chance to address it. | ||
2. Send an email to <[email protected]> with the details of the vulnerability. | ||
3. Provide as much detail as possible, including steps to reproduce the issue and any potential impact. | ||
|
||
Use this section to tell people how to report a vulnerability. | ||
We will acknowledge your report and work to investigate and address the issue as soon as possible. Once the issue is resolved, we will post an update in the repository. If you have a solution feel free to include that too. | ||
|
||
Tell them where to go, how often they can expect to get an update on a | ||
reported vulnerability, what to expect if the vulnerability is accepted or | ||
declined, etc. | ||
Thank you for helping to keep our project secure. |
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 |
---|---|---|
@@ -1,11 +1,17 @@ | ||
# Dependabot Configuration File | ||
# To get started with Dependabot version updates, you'll need to specify which | ||
# package ecosystems to update and where the package manifests are located. | ||
# Please see the documentation for all configuration options: | ||
# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates | ||
|
||
version: 2 | ||
updates: | ||
- package-ecosystem: "" # See documentation for possible values | ||
directory: "/docs" # Location of package manifests | ||
- package-ecosystem: "" | ||
directory: "/src" # Location of package manifests for Maven | ||
schedule: | ||
interval: "weekly" | ||
interval: "weekly" # Update dependencies weekly | ||
|
||
- package-ecosystem: "github-actions" # For GitHub Actions | ||
directory: "/.github/workflows" # Location of GitHub Actions workflows | ||
schedule: | ||
interval: "weekly" # Update dependencies weekly |
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,16 @@ | ||
name: Greetings | ||
|
||
on: [pull_request_target, issues] | ||
|
||
jobs: | ||
greeting: | ||
runs-on: ubuntu-latest | ||
permissions: | ||
issues: write | ||
pull-requests: write | ||
steps: | ||
- uses: actions/first-interaction@v1 | ||
with: | ||
repo-token: ${{ secrets.GITHUB_TOKEN }} | ||
issue-message: "Thank you for your issue report! I will look into it as soon as possible." | ||
pr-message: "Thank you for your pull request! I will look into it as soon as possible." |
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
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,27 @@ | ||
# This workflow warns and then closes issues and PRs that have had no activity for a specified amount of time. | ||
# | ||
# You can adjust the behavior by modifying this file. | ||
# For more information, see: | ||
# https://github.com/actions/stale | ||
name: Mark stale issues and pull requests | ||
|
||
on: | ||
schedule: | ||
- cron: '17 10 * * *' | ||
|
||
jobs: | ||
stale: | ||
|
||
runs-on: ubuntu-latest | ||
permissions: | ||
issues: write | ||
pull-requests: write | ||
|
||
steps: | ||
- uses: actions/stale@v9 | ||
with: | ||
repo-token: ${{ secrets.GITHUB_TOKEN }} | ||
stale-issue-message: 'Stale issue message' | ||
stale-pr-message: 'Stale pull request message' | ||
stale-issue-label: 'no-issue-activity' | ||
stale-pr-label: 'no-pr-activity' |
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
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
Oops, something went wrong.