mirror of
https://github.com/Wessel/Roommapper.git
synced 2026-07-28 18:50:53 +02:00
chore(readme): Update boilerpalte values to match repository
This commit is contained in:
14
.github/CONTRIBUTING.md
vendored
14
.github/CONTRIBUTING.md
vendored
@@ -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.
|
||||
|
||||
Reference in New Issue
Block a user