mirror of
https://github.com/TheRealOwenRees/echecsfrance.git
synced 2026-11-18 07:22:06 +00:00
1.2 KiB
1.2 KiB
Contributing
When contributing to this repository, please first discuss the change you wish to make via a GitHub issue.
Development Environment Setup
Prerequisites
Setup
- Fork the repository
- Clone your fork locally
- Run
yarnto install dependencies - Run
docker-compose upto start the MongoDB database and seed it with test data - Run
yarn devto start the development server
The test data is not persisted between restarts. Create a Docker volume if you wish for this to be the case.
Branching
- We use the GitHub Flow branching strategy.
- Use
feature/feature-nameas your branch name. - Non-feature branches are allowed, but please give a clear name to your branch such as
hotfix/fix-bug
Pull Request Process
- Squash all your commits into a single commit before pushing your branch
- Give a clear overview of your changes in the commit message
- When opening a PR, give a clear overview of what your changes are and why
- Wait for review and approval