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
So All Code Changes Happen Through Pull Requests as We Use Github Flow
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. - If you've added code that should be tested, add tests.
- If you've changed APIs, update the documentation.
- Ensure CI actions pass.
- Issue that pull request!
Report bugs using Github's issues
Report a bug by opening a new issue
Write bug reports with enough details for collaborators and maintainers to understand.
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.
All javascript code is linted with Prettier.
- Use spaces around operators :
count + 1 instead of count+1
- Use spaces after commas (unless separated by newlines)
- Limit code length to 100 chars per line
Exception : comments, strings and urls
- Consistent use of
semicolons - Avoid un-neccessary console logs [Not strict]
- Avoid un-neccessary alerts
- Avoid unused variable declarations
This document was adapted from the open-source contribution guidelines for Facebook's Draft