We love 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 use github to host code, to track issues and feature requests, as well as accept pull requests.
We Use Github Flow, So All Code Changes Happen Through Pull Requests
Pull requests are the best way to propose changes to the codebase (we use Github Flow). We actively welcome your pull requests:
- Fork the repo and create your branch from
master
. - Make sure your code [lints](#Use a Consistent Coding Style).
- Issue that pull request!
Report bugs using Github's issues
We use GitHub issues to track public bugs. Report a bug by opening a new issue; it's that easy!
- JavaScript Standard Style - We use eslint and provide a config file.
- Use SPDX-License-Identifiers:
- The SPDX license identifier shall be added at the first possible line in a file which can contain a comment.
// SPDX-License-Identifier: (GPL-3.0-or-later AND Apache-2.0)
We are initially GPL-3.0-or-later but will move to Apache-2.0 as soon as we refactor the stackoverflow code.
By contributing, you agree that your contributions will be dual licensed under (GPL-3.0-or-later AND Apache-2.0). You also agree to the Developer Certificate of Origin so please Sign-Off your commits: git commit -s
.
This document was based on a template by briandk adapted from the open-source contribution guidelines for Facebook's Draft