First of all, thank you for contributing, you are awesome!
Before starting, you should read, agree to, and follow these three things:
Report bugs at: https://github.com/plotly/react-alignment-viewer.js/issues/new.
When reporting a bug, please include:
- Any details about your local setup which might be helpful in troubleshooting
- Detailed steps to reproduce the bug. Where possible, please write a test case
If you are not able to do that, that's fine! Open an issue anyway and let us know as much information as you can. We will get back to you to determine the problem, and (hopefully) fix it.
The best way to send feedback is to create a new issue on GitHub.
If you are proposing a feature:
- Explain how you envision it working. Try to be as detailed as you can
- Try to keep the scope as narrow as possible. This will help make it easier to implement
- Feel free to include any code you might already have, even if it is just a rough idea
A plotly team member will take care of your issues.
Check out the open bugs - anything tagged with the [type: community] label is left open for community input and Pull Requests.
Here are a few rules to follow in order to make code reviews and discussions go more smoothly before maintainers accept and merge your work:
- you MUST run the test suite
- you MUST write (or update) unit tests
- you SHOULD write documentation
Please, write commit messages that make sense, and rebase your branch before submitting your Pull Request.
You may be asked to squash your
commits
too. This is to "clean" your Pull Request before merging it (we don't want
commits such as fix tests, fix 2, fix 3, etc.).
Also, while creating your Pull Request on GitHub, you MUST write a description which gives the context and/or explains why you are creating it.
For further information about creating a Pull Request, please read this blog post.
Thank you!