We hope you do the following before creating an issue:
- Search opened and closed issues first.
- State your operating system.
- State the version of Neta you're using when the issue happened.
- Post error stack traces (if any).
Neta encourages and welcomes contributing as long as you follow our guidelines as best you can.
Neta is built on many technologies, some of which you may need to know when wanting to contribute. We want Neta to be well-made, so we are pretty strict about pull requests!
Here is a list of some widespread things in Neta (in no particular order):
Our guidelines are config-form, we use eslint to keep a consistent style throughout the code, to keep it neat. Remember to always lint your code when making a contribution!
Neta has made this easy for you by setting up a npm-script, "lint":
$ npm run lint
We recommend you use a plugin for linting inside of your editor / IDE. For instance, linter-eslint when using Atom makes life a lot easier.
electron-prebuild is included as a developer depdendency. It's bound to "test" in the npm scripts, so you can test it with:
$ npm test
Take a look at issues labeled with help wanted if you don't know where to start. If there are none then feel free to poke around in the rest of the issues.
Neta is licensed under MIT and any contributions made towards Neta are (must be) licensed under MIT as well.