Skip to content

Latest commit

 

History

History
171 lines (117 loc) · 5.24 KB

CONTRIBUTING.md

File metadata and controls

171 lines (117 loc) · 5.24 KB
Raw

How To Contribute

Local development

Prerequisites

Steps

  1. Fork the repository (https://help.github.com/articles/fork-a-repo/)

  2. Clone the repository to your local machine (https://help.github.com/articles/cloning-a-repository/)

$ git clone [email protected]:[username]/rsschool-app.git
  1. Navigate into the directory where you've cloned the source code and install NPM dependencies
$ cd rsschool-app
$ npm install
  1. Create a branch for your feature
$ git checkout -b feature-x master
  1. The application requires a connection to a Postgres database. Here is how to get test database running locally:

Run a Postgres Database locally using Docker & Docker Compose

$ npm run db:up

Restore a test database snapshot

$ npm run db:restore

If you are done with development, stop the database;

$ npm run db:down
  1. Run the application in development mode with live reload:
$ npm start

  1. Do hacking 👩‍💻👨‍💻

  2. You could specify any environment variable during development using .env file. Make a copy of server/.env.example or nestjs/.env.example and rename it to server/.env or nestjs/.env respectively. We support it via dotenv package. More information about usage here: https://github.com/motdotla/dotenv.

  3. By default locally, you will be logged with admin access. If you want to change it, need to set RSSHCOOL_DEV_ADMIN to false in .env file

IMPORTANT: Never commit changes to .env file

  1. Do not forget to write Jest tests for your feature following Specs Styleguide

  2. Write end-to-end tests for your feature if applicable. Please see client/specs directory for more information. We use Playwright for end-to-end tests. You can run them using npm run test:e2e command and they suposed to work against test database snapshot.

  3. Make sure tests, lints pass and code formatted properly (they'll be run on a git pre-commit hook too)

$ npm test
$ npm run lint
$ npm run pretty
  1. Commit your changes using a descriptive commit message that follows our commit message conventions
$ git commit -m "feat: implement feature X"
  1. Push your branch to GitHub:
$ git push origin feature-x
  1. Create a pull request. We support "feature branch" deployments. If you want to deploy your pull request, please add deploy label during creation.

Database Migrations

If you made changes to DB models, you need to create a DB migration. Here are steps how to do it

  1. Go to /server
  2. Run npm run typeorm -- migration:generate -n {MigrationName} where {MigrationName} is your migration name.
  3. Import your migration to migrations array at ./server/src/migrations/index.ts
  4. Commit and push your changes

See more about Typeorm migrations at official docs Migrations

Pull Requests

  • Check how to create a pull request
  • Send a pull request to master branch
  • Fill template
  • Write a meaningful description
  • Include screenshots and animated GIFs in your pull request whenever possible
  • Add deploy label if you want to test your changes

Styleguides

Git Commit Messages

  • Use Conventional Commits format
  • Allowed Types:
    • build: - changes that affect the build system or external dependencies (example scopes: npm, webpack)
    • ci: - changes to our CI configuration files and scripts (example scopes: drone)
    • docs: - documentation only changes
    • feat: - a new feature
    • fix: - a bug fix
    • perf: - a code change that improves performance
    • refactor: - a code change that neither fixes a bug nor adds a feature
    • style: - сhanges that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
    • test: - adding missing tests or correcting existing tests
  • Use the present tense ("add feature" not "added feature")
  • Use the imperative mood ("move cursor to..." not "moves cursor to...")
  • Limit the first line to 72 characters or less
  • Reference issues and pull requests liberally after the first line

TypeScript Styleguide

We use Prettier for TypeScript formatting. Please run the following command before your commit:

npm run format

For your convience, you can integrate Prettier into your favorite IDE (https://prettier.io/docs/en/editors.html)

Unit-Tests Styleguide

  • Name spec file by adding .test to the name of tested file.

Example:

foo.ts
foo.test.ts // test file for foo.ts
  • Treat describe as a noun or situation.
  • Treat it as a statement about state or how an operation changes state.

Example:

describe('Header', () => {
  it('shows username', () => {
    //...
  });

  it('shows logout button', () => {
    //...
  });
});