1
0
mirror of https://github.com/Wessel/boilerplate-c.git synced 2026-07-16 04:53:36 +02:00

feat: initial commit and populate repo

This commit is contained in:
2023-02-06 15:13:16 +01:00
parent 5f7d41f1a6
commit 1c3bb4e360
17 changed files with 159 additions and 237 deletions

View File

@@ -1,12 +1,11 @@
# Contributing
If you wish to contribute to $(PROJECT_NAME), feel free to fork the repository and submit a pull request.
[ESLint](https://eslint.org/) is enforced to correct most typo's you make and keep the code style the same throughout the whole project, so it would be appreciated if you installed [ESLint](https://eslint.org/) to your editor of choice
If you wish to contribute to c-boilerplate, feel free to fork the repository and submit a pull request.
[EditorConfig](https://editorconfig.org) is enforced to correct most typo's you make and keep the code style the same throughout the whole project, so it would be appreciated if you installed [EditorConfig](https://editorconfig.org) to your editor of choice
## Setup
To get ready to work on the codebase, please do the following:
1. Fork & clone the repository, and make sure you're on the **master** branch
2. Run `yarn --dev` or `npm install --dev`
4. Code your heart out and test using `yarn test` or `npm run test`
6. [Submit a pull request](https://github.com/Wessel/$(PROJECT_NAME)/compare)
4. Code your heart out and test using `make dev`
6. [Submit a pull request](https://github.com/Wessel/c-boilerplate/compare)