owenrees/echecsfrance
1
0
Fork 0
mirror of https://github.com/TheRealOwenRees/echecsfrance.git synced 2026-07-22 20:16:57 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
7adff99e288bfd26767c2dae8a900c2279c9b7be
echecsfrance/CONTRIBUTING.md
T
owenrees 67e97b6ca0 create development guide 
remove deps badge

correct mongo connection string and driver update

seed data for developer environment, database as docker image
2025-11-20 10:55:09 +01:00

1.2 KiB
Raw Blame History

Contributing

When contributing to this repository, please first discuss the change you wish to make via a GitHub issue.

Development Environment Setup

Prerequisites

Setup

  1. Fork the repository
  2. Clone your fork locally
  3. Run yarn to install dependencies
  4. Run docker-compose up to start the MongoDB database and seed it with test data
  5. Run yarn dev to 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-name as 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

  1. Squash all your commits into a single commit before pushing your branch
  2. Give a clear overview of your changes in the commit message
  3. When opening a PR, give a clear overview of what your changes are and why
  4. Wait for review and approval
Reference in New Issue View Git Blame Copy Permalink