chore(readme): Update boilerpalte values to match repository

This commit is contained in:
2024-03-18 09:28:21 +01:00
parent 5a78295dfc
commit 7b264b778a
35 changed files with 409 additions and 34 deletions

View File

@@ -6,9 +6,9 @@ Used linters:
[EditorConfig](https://editorconfig.org)
--->
If you wish to contribute to {{project.name}}, feel free to fork the repository and submit a pull request.
{{project.linter}} is enforced to correct most typo's you make and keep the code style the same throughout the whole project,
so it would be much appreciated if you installed {{project.linter}} to your editor of choice
If you wish to contribute to Roommapper, feel free to fork the repository and submit a pull request.
Editorconfig is enforced to correct most typo's you make and keep the code style the same throughout the whole project,
so it would be much appreciated if you installed Editorconfig to your editor of choice
<!---
Prerequisites for Node.JS:
@@ -19,8 +19,8 @@ Prerequisites for Node.JS:
* [(OPTIONAL) Yarn](https://yarnpkg.com)
--->
## Prerequisites
The following prerequisites must be met before installing {{project.name}}:
{{setup.prerequisites}}
The following prerequisites must be met before installing Roommapper:
- Dotnet >=8.0.0
<!---
Install commands:
@@ -39,11 +39,11 @@ To get ready to work on the codebase, please do the following:
1. Fork & clone the repository, and make sure you are on the **master** branch
2. Run {{setup.install}}
3. Code your ideas and test them using {{setup.test}}
4. [Submit a pull request](https://github.com/{{project.master}}/{{project.name}}/compare)
4. [Submit a pull request](https://github.com/Wessel/Roommapper/compare)
## Testing
When creating any new functions, please also create unit tests for them in the `tests` directory.
Use the library associated with the project when creating such tests.
When modifying existing functions, make sure to test them before making a pull request, this will prevent
anything from breaking on the production environment.
anything from breaking on the production environment.

View File

@@ -12,7 +12,10 @@ body:
attributes:
label: Which part is this bug report for?
options:
- {{tree.parts}}
- API Server
- JSON parser
- Room mapper
- Route solver
validations:
required: true
- type: textarea
@@ -32,7 +35,7 @@ body:
attributes:
label: Code sample
description: Include a reproducible, minimal code sample. This will be automatically formatted into code, so no need for backticks.
render: {{project.lang}}
render: C#
placeholder: |
Your code sample should be...
... Minimal - Use as little code as possible that still produces the same problem (and is understandable)
@@ -48,9 +51,9 @@ body:
- type: input
id: lang-version
attributes:
label: '{{project.lang}} version'
label: 'C# version'
description: |
Which version of {{project.lang}} are you using?
Which version of C# are you using?
validations:
required: true
- type: input
@@ -75,4 +78,4 @@ body:
label: I have tested this issue on a development release
placeholder: d23280c (commit hash)
description: |
The issue might already be fixed in a development release or main. This is not required, but helps us greatly.
The issue might already be fixed in a development release or main. This is not required, but helps us greatly.

View File

@@ -4,4 +4,6 @@ blank_issues_enabled: false
# url:
# about:
contact_links:
- {{project.contact}}
- name: "Email"
url: "mailto:contact@wessel.gg"
about: "Contact me via email"

View File

@@ -12,7 +12,10 @@ body:
attributes:
label: Which part is this feature request for?
options:
- {{tree.parts}}
- API Server
- JSON parser
- Room mapper
- Route solver
validations:
required: false
- type: textarea
@@ -39,4 +42,4 @@ body:
id: additional-context
attributes:
label: Other context
description: Any other context, screenshots, or file uploads that help us understand your feature request.
description: Any other context, screenshots, or file uploads that help us understand your feature request.

View File

@@ -1,6 +1,6 @@
---
name: Pull Request
about: Propose changes to {{project.name}}
about: Propose changes to Roommapper
title: "[PR] Your changes"
labels: pullrequest
assignees: Wessel
@@ -14,6 +14,6 @@ assignees: Wessel
- [ ] Code changes have been tested and there aren't any typos in it
**Semantic versioning classification:**
- [ ] This PR changes {{project.name}} core codebase (methods or parameters added)
- [ ] This PR changes Roommapper core codebase (methods or parameters added)
- [ ] This PR includes breaking changes (methods removed or renamed, parameters moved or removed)
- [ ] This PR **only** includes non-code changes, like changes to documentation, README, etc.

View File

@@ -1,5 +1,5 @@
addReviewers: true
reviewers:
- {{project.reviewers}}
- Wessel
numberOfReviewers: 0
runOnDraft: true
runOnDraft: true