Skip to content
This repository has been archived by the owner on May 12, 2023. It is now read-only.

Latest commit

 

History

History
126 lines (93 loc) · 4.74 KB

CONTRIBUTING.md

File metadata and controls

126 lines (93 loc) · 4.74 KB
Raw

Contributing guide

Thanks for taking a moment to read this guide. It's very important to have everyone on the same page. This guide describes how to:

  • Set up your environment
  • Run the application
  • Run tests
  • Submit Pull Requests
  • Follow our code practices

(If you are new to GitHub, you might start with a basic tutorial and check out a more detailed guide to pull requests.)

All contributors retain the original copyright to their stuff, but by contributing to this project, you grant a world-wide, royalty-free, perpetual, irrevocable, non-exclusive, transferable license to all users under the terms of the license under which this project is distributed.

Set up your environment

Git

Make sure you have Git installed on your machine. You can follow this link for instructions.

NPM

NodeJS is required to build and start this app. You can look for install instructions here. Make sure you have at least the version 16.10 (that includes yarn)

IDE

If you like, Microsoft VS Code can be a great option. Lots of extensions and integrations. You can learn how to install here.

Here are some suggested extensions:

Check-style

To enforce a better solution and a stronger product we decided to use the Airbnb ESLint check-style. This way also helps us to have a dedicated pipeline to check for common errors and possible bugs.

Also, run yarn lint before making a PR, so any style error not addressed can be checked and you can use yarn lint --fix to fix small issues.

Note that if you choose VS Code as your IDE, we highly recommend above mentioned extension ESLint, by Microsoft. Here's the link to the Marketplace: https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint

Run this application

Now that your environment is all set up, we can run the application. To do that, first you need to install required dependencies.

Remember of setting up the required environment variables. You can create a .env file containing:

REACT_APP_SERVER_URL=
REACT_APP_NRSPARWEBAPP_VERSION=
REACT_APP_KC_URL=
REACT_APP_KC_REALM=
REACT_APP_KC_CLIENT_ID=
REACT_APP_ENABLE_MOCK_SERVER=

And if you want to run Cypress, please add:

CYPRESS_USERNAME=
CYPRESS_PASSWORD=

If don't have these values, please reach a member of the team

Just run:

yarn install --frozen-lockfile

Once is finished, you can get it up and running by typing

yarn start

Run tests

You can run tests running yarn test. Tests coverage reports can be seen on you command line window and also on GitHub, in your commits and pull requests.

PS: We have snapshot tests, so keep in mind the tests may break if you forget to update snapshots. To update them run yarn test -u

Submit pull requests

We use git flow, so all code changes happen through Pull Requests. There's a Pull Request template that you can fill. The more complete the better. If you have images, screen capture or diagrams, that helps, but it's not required. Don't forget to add reviewers, assign to yourself and add labels.

React Query Conventions

  • /posts -> ['posts']
  • /posts/1 -> ['posts', post.id]
  • /posts?author=1 -> ['posts', { author: 1 }]
  • /posts/2/comments -> ['posts', post.id, 'comments']

Follow our best practices

  • TypeScript source code must be formatted according to Airbnb ESLint, as mentioned. Make sure to follow this rule and you're good to go.
  • We use conventional commits because it makes the process of generating changelogs possible. If that's new for you, please take a moment to read it. You can start with the summary and go from there.
    • Basically you need to write your commits messages starting with a tag that is related with the change that you're doing. Tags can be one of:
    • build: Changes that affect the build system or external dependencies
    • ci: Changes to our CI configuration files and scripts
    • 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
    • test: Adding missing tests or correcting existing tests

Take a look here to read more about the commit message format.