Hello! We would be very happy to have new contributors to make Briefly Planning Poker even better! This guide will help you to understand how we work and a few rules about the project
As you can see, all the project (functions, comments, files and folders name and commands) and repository (branches, pull requests, issues, docs and commits) are in english.
All commits are written using gitmoji guide
We're using ESLint and Prettier at the project, then it will be necessary install them on your editor.
In case you're using VS Code:
- Download and install Prettier - Code formatter
- Download and install ESLint
- Restart VS Code
-
Optional: you can add this line
"editor.codeActionsOnSave": { "source.fixAll.eslint": true }at setting.json to fix some kind of warnings after saving
The repository doesn't allow merging directly at main/master, thus first you'll need to develop at your new local branch and create a pull request which must be reviewed by at least one admin member from organization team and can't have any unresolved conversation.
We recommend that everything be registered as an issue, so that any contributors can start working on it.
Currently the project has tests only at Store library (coverage always above 80%), but we're working on add all remaining tests.
For now the repository doesnt have any continuous integration flow, we're working on enabled GitHub Actions to run all the tests. However there's a Heroku App production set up, so after merging a new feature we can do the deploy by using admin Heroku account.