# Contributing to bp2d.js
To date, this project is mainly serves as an exercise for @bupedev to learn about Typescript/Javascript libraries. However, if you would like to be involved you are more than welcome to do so. You are welcome to do any of the following at your own discretion:

- Reporting a bug
- Discussing the current state of the code (**feedback is greatly appreciated**)
- Submitting a fix
- Proposing new features
- Becoming a maintainer

## Checking-in Code
We use Github to host code, to track issues and feature requests, as well as accept pull requests. Pull requests are the best way to propose changes to the codebase (we use [Github Flow](https://docs.github.com/en/get-started/quickstart/github-flow)).
## GitHub Issues
We use [GitHub issues](https://github.com/bupedev/bp2d/issues) to track public bugs and enhancement request. If there are any bugs you wish to report or enhancement requests you would like to raise, you can do so by [opening a new issue](https://github.com/bupedev/bp2d/issues/new).

## Bug Reports
It's really important to gice as much context around a bug as you can. Without sufficient clear information, a lot of time can be wasted analysing potential defects. If you have a bug/defect to report, do your best to include the following:

- A quick summary and/or background
- Steps to reproduce (supporting sample code would be ideal)
- 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)

People *love* thorough bug reports, if you know, you know.

## Coding Style
This repository has yet to setting on any code stylization standards. When it has, details will be included here. In the mean time, ensure any code you intend to contribute to the repository is clean and readable.

## License
By contributing, you agree that your contributions will be licensed under its MIT License.

## References
This document was adapted from the open-source contribution guidelines for [Facebook's Draft](https://github.com/facebook/draft-js/blob/a9316a723f9e918afde44dea68b5f9f39b7d9b00/CONTRIBUTING.md)