Skip to content

Latest commit

 

History

History
37 lines (27 loc) · 1.96 KB

CONTRIBUTING.md

File metadata and controls

37 lines (27 loc) · 1.96 KB
Raw

Contributing to AI4-Dashboard

Thank you for taking the time in contributing to our project, we love your input! Before starting, be sure to read our Read our Code of Conduct.

We use Github Flow, to ensure that all code changes happens through an approved and reviewed pull request

Pull requests are very welcomed! to create one you should:

  1. Fork the repo and create your branch from main.
  2. If you've added code that should be tested, add tests.
  3. If needed, update the documentation.
  4. Ensure the test suite passes.
  5. Make sure your code lints.
  6. Issue that pull request!

Use a Consistent Coding Style

We use the official Angular code style plus a couple of things that you have to take into account

  • 4 spaces for indentation rather than tabs
  • We use pre-commits hooks using husky that will lint your code and run all the test
    • If you want to run this by yourself you can run npm lint and npm test respectively

Did you find a bug? Help us and the community by providing a detailed bug report

Great Bug Reports tend to have:

  • A quick summary and/or background
  • Steps to reproduce
  • What you expected would happen
  • What actually happens
  • Notes (possibly including why you think this might be happening, or stuff you tried that didn't work)

Report bugs using Github's issues

We use GitHub issues to track public bugs. Report a bug by opening a new issue; it's super simple!

Any contributions you make will be under the Apache License 2.0

In short, when you submit code changes, your submissions are understood to be under the same Apache License 2.0 that covers the project. Feel free to contact the maintainers if that's a concern.