First of all thanks for taking time to help and contribute. 👍
The general guideline of contributing to this project is defined by Contributer Covenant 1.2.. Please make sure that you have read it.
neutron makes use of a number of other projects, so before submitting any issues please make sure that your problem is either neutron itself or its integration with other projects.
When filing issues please provide as much information as possible:
- Your operating system
- Electron version
- Any other packages causing the issue
- Log files, exact error messages
It is preferred to have an issue filed before submitting a pull request. For requests with minor code changes you could submit the pull request directly.
This section has been adapted from electron's contribution section
- Use the present tense ("Add feature" not "Added feature")
- Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
- Limit the first line to 72 characters or less
- Reference issues and pull requests liberally
- Consider starting the commit message with an applicable emoji:
- 🎨
:art:when improving the format/structure of the code - 🐎
:racehorse:when improving performance - 🚱
:non-potable_water:when plugging memory leaks - 📝
:memo:when writing docs - 🐧
:penguin:when fixing something on Linux - 🍎
:apple:when fixing something on Mac OS - 🏁
:checkered_flag:when fixing something on Windows - 🐛
:bug:when fixing a bug - 🔥
:fire:when removing code or files - 💚
:green_heart:when fixing the CI build - ✅
:white_check_mark:when adding tests - 🔒
:lock:when dealing with security - ⬆️
:arrow_up:when upgrading dependencies - ⬇️
:arrow_down:when downgrading dependencies - 👕
:shirt:when removing linter warnings
- 🎨