Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
42 lines (28 loc) · 962 Bytes

CONTRIBUTING.md

File metadata and controls

42 lines (28 loc) · 962 Bytes
Raw

Contributing

To get started, fork this repository and clone it to your local machine. Then, create a new branch for your changes:

git clone [email protected]:your-username/structpack.git
cd structpack
git checkout -b my-feature

Install the dependencies:

npm install

You can now start working on your feature. Remember to add tests for your changes to ensure that they work as expected. Also examples and documentation are very welcome.

Run the tests before commiting your changes:

npm test

Run type checks as well:

npm run typecheck

Code Style

In most cases, your IDE can automatically format your code so it won't be too much work. Please follow the following points:

  • Use TAB for indentation. The tab width is 4 spaces.
  • Always use semicolons.
  • Use single quotes for strings.
  • Always wrap blocks in curly braces.

Commit Messages

Just be clear and concise, no special formats are required.