search

wokwi / avr8js

Arduino (8-bit AVR) simulator, written in JavaScript and runs in the browser / Node.js
https://blog.wokwi.com/avr8js-simulate-arduino-in-javascript/
MIT License
481 stars 78 forks source link

Create a CONTRIBUTING guide #23

Closed urish closed 4 years ago

urish commented 4 years ago

A document that explains about the project structure, the tools that we use, how to build it, and how to contribute. Some of the things we'd like to mention:

  1. Commit messages - we use conventional commits.
  2. License - the contributed code is released under the MIT license.
  3. Tooling - we use eslint and prettier to keep the code clean, and editorconfig to configure the indent in a cross-editor fashion.
  4. Recommended code editor - Visual Studio code is preferred, and we have an extensions.json, so when you open the project in VSCode, it will automatically prompt to install recommended extensions.
  5. Recommended reading material - Datasheets, etc
  6. Tests: we use jest for the unit-tests, and we aim to get a high coverage of the core library. It's recommended to use Wallaby.js to run the tests in the IDE and also track the code coverage.