Thanks for your interest in contributing to ED Tightbeam!
We're excited to have you help out.
Every bug report, pull request, question, and suggestion is important to us.
Below you will find some information for bug reporting as well as some quick guidelines and steps for contributing.
Be sure to check out the Code of Conduct.
Thanks for taking the time to let us know about errors you encounter. This is a very important part of making this software better.
We really appreciate your time.
When creating an Issue, please try to follow the template we've provided and provide as much detail as possible about what was going on when the error occurred.
- This project follows the Airbnb JavaScript Style Guide
and as long as you
npm installyou should get the necessaryeslintdependencies for checking your code; it's recommended to install the eslint plugin for your editor - This project makes use of EditorConfig for consistent file conventions; ensure you have your editor configured to work with EditorConfig
- This project follows the semver guidelines for versioning
- This project uses Electron, React, and elite-dangerous-journal-server
NOTE: If this process seems like a lot, we plan to add some mock Journal data and better ways to test the code in the future. If you get lost at any point, just open an issue and we'll help walk you through it.
git clonenpm install- You'll need two Terminal Windows:
npm run watchnpm start- Make your changes
- Follow the Packaging instructions below:
- Run
npm run build - Run
npm run generate - Run
cd app - Run
npm install - Run
npm run package - Test the application:
- Built application files can be found in
ed-tightbeam/dist/[current version number]/
- Submit a Pull Request and follow our PR Template
- Accept an Internet High Five from us for helping out
