Please use the Issue Tracker to discuss potential improvements you want to make before sending a Pull Request. The roadmap is probably the best place to find areas where help would most be appreciated.
The Issue Tracker may contain items labelled good first issue or help wanted from time to time.
Pull Requests are used for contributions. Code must be well-tested and not decrease the test coverage significantly.
Please commit changes to a separate branch in your fork
so that we can work together making changes to it before it
is ready to be merged. Name your branch something like
<username>/feature.
Once you are ready, you can create a Pull Request for it to be
merged into the main branch in this repo.
The following commands must pass for a Pull Request to be considered:
$ npm test
$ npm run lint
You can also check the test coverage by running:
$ npm run test:coverage
Use the following command to preview them:
$ npm run docs
For minimal effort, the repository is configured to run in a remote dev container from VS Code.
- No need to install Node.js or any other project-specific tooling and dependencies
- No risk of your local machine environment getting in the way
- Consistent development environment no matter what OS is used
- Useful extensions preinstalled in the container, independent of your local VS Code settings
- VS Code + Remote Development extension
- git
- Docker
- Launch VS Code
- Click the Remote Development icon in the bottom left corner of the UI, then "Clone repository in Container Volume..."
- Paste
https://github.com/boardgameio/boardgame.ioor use your own fork, any branch, or a pull request - The container will start up and install all required dependencies automatically
- Terminal output will cease when everything is set up and ready to go
- Open "NPM Scripts" panel in the sidebar
- Click on
package.json > start
If the NPM scripts panel is not visible in the Explorer sidebar, open the Explorer settings (3 dots) and check "NPM Scripts".