MiraWeb and its accompanying packages are open source projects and contributions and help from the community are strongly encouraged and important to improve the software. Here are some things we'd like you to keep in mind in order to help with keeping the process smooth and organized.
If you've come across a bug, would like to request a feature or just ask a question, please use the GitHub Issues section for [MiraWeb][issues]. In order to make things easier for the maintainers and others the following would be helpful:
- Use the search. It's possible that someone already filed the issue or asked the question you have in mind, so please try to avoid duplicates.
- Distinct test case Please try to provide detailed info about your bug, feature request or question. In the case of a bug please try to share clear reproducible steps or ideally even an isolated, reproducible test case.
- Share Info Please try to share as much helpful info as possible. This would include things like your OS, browser version, MiraWeb version, potential screenshots etc.
We are happy to accept your contributions in the form of pull requests from the GitHub Community. Please make sure your contributions are well-formatted, pass the tests (use npm run test) and make use of commonly understood commit messages.
- Use tab characters for spacing
- No trailing whitespace and also blank lines should have no whitespace
- Make use of strict equals === unless type coercion is intended
- Follow conventions already established in project's source code
- Validate changes with eslint and build/test the project to make sure you didn't break anything
In order to simplify the usage of common project settings across systems, editors and IDEs we are using EditorConfig. Please refer to http://editorconfig.org/ for more info and check the settings.