# Contributing We appreciate your input! We want to make contributing to this project as easy and transparent as possible, whether it's: - Reporting a bug - Discussing the current state of the code - Submitting a fix - Proposing new features - Becoming a maintainer ## We Develop with Github We use github to host code, to track issues and feature requests, as well as accept pull requests. ## We Use [Github Flow](https://guides.github.com/introduction/flow/index.html), So All Code Changes Happen Through Pull Requests Pull requests are the best way to propose changes to the codebase (we use [Github Flow](https://guides.github.com/introduction/flow/index.html)). We actively welcome your pull requests: 1. Fork the repo and create your branch from `master`. 2. If you've added code, add tests. 3. If you've fixed a bug, add regression tests. 4. If you've changed APIs, update the documentation. 5. Ensure the test suite passes. 6. Make sure your code lints. 7. Issue that pull request! In general pull requests should: - Only fix/add the functionality in question **OR** address wide-spread whitespace/style issues, not both. - Add unit or integration tests for fixed or changed functionality (if a test suite already exists). - Address a single concern in the least number of changed lines as possible. - Include documentation in the repo For changes that address core functionality or would require breaking changes (e.g. a major release), it's best to open an Issue to discuss your proposal first. This is not required but can save time creating and reviewing changes. ## Any contributions you make will be under the ISC Software License In short, when you submit code changes, your submissions are understood to be under the same [ISC License](https://choosealicense.com/licenses/isc/) that covers the project. Feel free to contact the maintainers if that's a concern. ## Report bugs using Github's issues We use GitHub issues to track public bugs. Report a bug by [opening a new issue](https://github.com/aeternity/aepp-calldata-js/issues); it's that easy! ## Write bug reports with detail, background, and sample code **Great Bug Reports** tend to have: - A quick summary and/or background - Steps to reproduce - Be specific! - Give sample code if you can. - 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. Badly reported issues and bug report might be closed without review. ## Use a Consistent Coding Style * 4 spaces for indentation rather than tabs * this library is using vanilla javascript * no complication/build phases are accepted * it must support recent major platforms and browsers according to [Can I Use](https://caniuse.com) ## License By contributing, you agree that your contributions will be licensed under its ISC License.