Skip to content

Latest commit

 

History

History
206 lines (139 loc) · 6.35 KB

CONTRIBUTING.md

File metadata and controls

206 lines (139 loc) · 6.35 KB
Raw

Contributing to Library App

As the application is just a proof of concept (POC), there are many rooms of improvement. We would love for you to contribute to the application and help make it even better than it is today! As a contributor, here are the guidelines we would like you to follow:

Submission Guidelines

Submitting a Pull Request (PR)

Before you submit your Pull Request (PR) consider the following guidelines:

  1. Search GitHub Pull Requests for an open or closed PR that relates to your submission. You don't want to duplicate effort.

  2. Fork this repository.

  3. Make your changes in a new git branch:

    git checkout -b my-fix-branch main

  4. Create your patch, including appropriate test cases.

  5. Follow our Coding Rules.

  6. Run the full test suite (see common scripts), and ensure that all tests pass.

  7. Commit your changes using a descriptive commit message that follows our commit message conventions. Adherence to these conventions is necessary because release notes are automatically generated from these messages.

    git commit -a

    Note: the optional commit -a command line option will automatically "add" and "rm" edited files.

  8. Push your branch to GitHub:

    git push origin my-fix-branch

  9. In GitHub, send a pull request to library-app:main.

  • If we suggest changes then:

    • Make the required updates.

    • Re-run all test suites to ensure tests are still passing.

    • Rebase your branch and force push to your GitHub repository (this will update your Pull Request):

      git rebase main -i
git push -f

That's it! Thank you for your contribution!

After your pull request is merged

After your pull request is merged, you can safely delete your branch and pull the changes from the main (upstream) repository:

  • Delete the remote branch on GitHub either through the GitHub web UI or your local shell as follows:

    git push origin --delete my-fix-branch

  • Check out the main branch:

    git checkout main -f

  • Delete the local branch:

    git branch -D my-fix-branch

  • Update your main with the latest upstream version:

    git pull --ff upstream main

Development Setup

You will need Node.js version >= 10.13.0 (except for v13), RabbitMQ, MongoDB to run all the services locally.

Alternatively, you could run in Docker without intalling the dependencies explicitly.

  1. After cloning the repo, run:
$ npm ci

Commonly used NPM scripts

# build all services
$ npm run build:all

# run the full unit tests suite
$ npm run test
$ npm run test:e2e

# run linter
$ npm run lint

Coding Rules

To ensure consistency throughout the source code, keep these rules in mind as you are working:

  • All features or bug fixes must be tested by one or more specs (unit-tests).
  • We follow Google's JavaScript Style Guide, but wrap all code at 100 characters. An automated formatter is available (npm run format).

Commit Message Guidelines

We have very precise rules over how our git commit messages can be formatted. This leads to more readable messages that are easy to follow when looking through the project history.

Commit Message Format

Each commit message consists of a header, a body and a footer. The header has a special format that includes a type, and a subject:

<type>(<scope>): <subject>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>

The header is mandatory and the scope of the header is optional.

Any line of the commit message cannot be longer than 100 characters! This allows the message to be easier to read on GitHub as well as in various git tools.

Footer should contain a closing reference to an issue if any.

Samples:

docs: update change log to beta.5
fix: need to depend on latest rxjs and zone.js

Revert

If the commit reverts a previous commit, it should begin with revert:, followed by the header of the reverted commit. In the body it should say: This reverts commit <hash>., where the hash is the SHA of the commit being reverted.

Type

Must be one of the following:

  • build: Changes that affect the build system or external dependencies (example scopes: npm, turborepo)
  • ci: Changes to CI configuration files and scripts (example scopes: GitHub Action)
  • 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: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
  • test: Adding missing tests or correcting existing tests

Subject

The subject contains succinct description of the change:

  • use the imperative, present tense: "change" not "changed" nor "changes"
  • don't capitalize first letter
  • no dot (.) at the end

Body

Just as in the subject, use the imperative, present tense: "change" not "changed" nor "changes". The body should include the motivation for the change and contrast this with previous behavior.

Footer

The footer should contain any information about Breaking Changes and is also the place to reference GitHub issues that this commit Closes.

Breaking Changes should start with the word BREAKING CHANGE: with a space or two newlines. The rest of the commit message is then used for this.

A detailed explanation can be found in this document.

The contribution guide is inspired by NestJS contribution guide.