mirror of
https://github.com/monkeytypegame/monkeytype.git
synced 2025-02-01 19:38:24 +08:00
docs: add commit message guidelines section
This commit is contained in:
Miodec
parent
e20445a519
commit
65a34fb4e7
2 changed files with 41 additions and 9 deletions
|
|
@ -31,7 +31,7 @@ We use [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) fo
|
|||
For commit types, we use the following:
|
||||
|
||||
- `feat`: A new feature
|
||||
- `enhance`: An enhancement to an existing feature
|
||||
- `impr`: An improvement to an existing feature
|
||||
- `fix`: A bug fix
|
||||
- `docs`: Documentation only changes
|
||||
- `style`: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
|
||||
|
|
@ -40,9 +40,43 @@ For commit types, we use the following:
|
|||
- `test`: Adding missing tests or correcting existing tests
|
||||
- `build`: Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm)
|
||||
- `ci`: Changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs)
|
||||
- `revise`: A change that revises a previous commit
|
||||
- `revert`: Reverts a previous commit
|
||||
- `chore`: Other changes that don't apply to any of the above
|
||||
|
||||
For example:
|
||||
|
||||
```
|
||||
feat: add freedom mode
|
||||
|
||||
Added freedom mode which allows the user to backspace to previous words, even if they are typed correctly
|
||||
```
|
||||
|
||||
```
|
||||
feat(theme): add superuser
|
||||
```
|
||||
|
||||
```
|
||||
feat(language): add english language
|
||||
```
|
||||
|
||||
```
|
||||
feat(quote): add five spanish quotes
|
||||
```
|
||||
|
||||
```
|
||||
fix: funbox not persisting
|
||||
|
||||
Fixed a bug where the fubox styling would not persist across pages due mistakenly removing all classes from the body element
|
||||
|
||||
Fixes #123
|
||||
```
|
||||
|
||||
```
|
||||
impr: add more highlight modes
|
||||
|
||||
Added a few more highlight modes: next word, next two words, next three words
|
||||
```
|
||||
|
||||
### Theme Guidelines
|
||||
|
||||
<!-- TODO: add screenshots to provide examples for dos and don'ts -->
|
||||
|
|
|
|||
|
|
@ -91,8 +91,8 @@ Follow these steps if you want to work on anything involving the database/accoun
|
|||
|
||||
2. Setup the database server
|
||||
|
||||
| Local Server | Docker (recommended) |
|
||||
| -------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| Local Server | Docker (recommended) |
|
||||
| -------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| <ol><li>Install [MongoDB Community Edition](https://docs.mongodb.com/manual/administration/install-community/)</li><li>Make sure it is running</li></ol> | <ol><li>Install [Docker](http://www.docker.io/gettingstarted/#h_installation) on your machine</li><li>Run `docker-compose up` from the `./backend` directory (this is also how you start the backend server)</li></ol> |
|
||||
|
||||
3. (Optional) Install [MongoDB-compass](https://www.mongodb.com/try/download/compass?tck=docs_compass). This tool can be used to see and manipulate your database visually.
|
||||
|
|
@ -103,15 +103,14 @@ Follow these steps if you want to work on anything involving the database/accoun
|
|||
- Run `npm run install-all` in the project root to install all dependencies.
|
||||
- If you are on Windows, use `npm run install-windows`.
|
||||
- If neither works, you will have to run `npm install` in root, frontend, and backend directories.
|
||||
Now you are ready to build and run Monkeytype.
|
||||
|
||||
Now you are ready to build and run Monkeytype.
|
||||
|
||||
### Using Docker:
|
||||
|
||||
- Frontend:
|
||||
```
|
||||
cd frontend && docker-compose up
|
||||
```
|
||||
|
||||
- Backend (in another terminal window):
|
||||
```
|
||||
cd backend && docker-compose up
|
||||
|
|
@ -123,7 +122,6 @@ Follow these steps if you want to work on anything involving the database/accoun
|
|||
```
|
||||
npm run dev
|
||||
```
|
||||
|
||||
- Only frontend (if you skipped the Backend section):
|
||||
```
|
||||
npm run dev-fe
|
||||
|
|
@ -137,7 +135,7 @@ Note: Rebuilding doesn't happen instantaneously and depends on your machine, so
|
|||
|
||||
Code style is enforced by [Prettier](https://prettier.io/docs/en/install.html), which automatically runs every time you make a commit.
|
||||
|
||||
For guidelines on adding themes, languages or quotes, pleases refer to [CONTRIBUTING.md](./CONTRIBUTING.md). Following these guidelines will increase the chances of getting your change accepted.
|
||||
For guidelines on commit messages, adding themes, languages or quotes, pleases refer to [CONTRIBUTING.md](./CONTRIBUTING.md). Following these guidelines will increase the chances of getting your change accepted.
|
||||
|
||||
## Questions
|
||||
|
||||
|
|
|
|||
Loading…
Reference in a new issue