Skip to content

Latest commit

 

History

History
45 lines (30 loc) · 1.33 KB

CONTRIBUTING.md

File metadata and controls

45 lines (30 loc) · 1.33 KB
Raw

Contributing to T.A.D.S.

👍🎉 First of all, thanks for taking the time to contribute! 🎉👍

All your contributions are very welcome, whether it's:

  • Reporting a bug
  • Discussing the current state of the code
  • Submitting a fix
  • Proposing new features
  • Becoming a maintainer

Thank you so much! 👏

Development

./tads install-dependencies --dev
make lint
make test

Pull Requests

Pull requests are the best way to propose changes to the codebase (we use Github Flow). We actively welcome your pull requests.

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

Issues and Feature Requests

We use GitHub issues to track bugs and feature requests. Please ensure your description is clear and has sufficient instructions to be able to reproduce the issue.

Coding Style

  • Referer to .editorconfig. We encourrage you to use a compatible IDE or plugin
  • Run make lint to conform to our lint rules

License

By contributing to T.A.D.S., you agree that your contributions will be licensed under its MIT License.