Hello there and thank you for your interest! Insights is an open source project and all contributions are welcome. Please read this document before opening a new issue or a pull request. The aim is to make contributing as easy and beginner friendly as possible.
If you have any questions, you may email the maintainer directly.
Bugs or other unexpected behaviour can be reported using the Issues page. Try to describe the problem in detail to make it easier to fix.
Don't hesitate to report an issue you may have found with the application. Even minor typo corrections are appreciated.
New features can be suggested or requested by opening a new issue. If you wish to contribute to the source code, fork the repository and make a pull request. Please explain what you did and how you think it would improve the application! Your pull request will be reviewed as soon as possible. If you don't have any new ideas but would still like to contribute, take a look at the list of open issues.
Make as many pull requests as you want. It is recommended to keep a pull request small and to not change too many things at once. Don't make a pull request you wouldn't want to review yourself!
Refactoring, testing and optimizing existing code is also highly encouraged.
ESLint is used to enforce a consistent code style. The file .eslintrc contains the specific rules the code should follow. Before making a pull request, check the code style with npm run lint and fix any issues that are detected.
Prettier is used to format the code. Formatting can be done manually by running npm run format or automatically when saving a file, if you have the plugin installed.
Keep the commits small so they are easy to handle. Don't change too many things per commit. Commit messages should be descriptive. Pay attention to good grammar and use the imperative mood.
# Yes
$ git commit -m "Create README.md"
# No
$ git commit -m "Changed something"
$ git commit -m "Created README.md"
$ git commit -m "README"
$ git commit -m "Some changes"
$ git commit -m "Removed some links"If you wish you contribute to the source code itself, here's how to install the application and start developing on your machine. You should be familiar with React, JavaScript/TypeScript and have Node.js installed. I would recommend using Visual Studio Code but any other editor will do just fine if Code is not your thing.
# Get the source code
$ git clone git@github.com:rikurauhala/insights.git
# Change directory
$ cd insights
# Install dependencies
$ npm installAfter running the application, your default browser should automatically open and the app should be running locally. If not, go to http://localhost:5173 manually.
# Run the application
$ npm run devPlease make sure to always run tests before creating a pull request to ensure nothing breaks.
# Run tests
$ npm run cypress:runHere are some useful resources.