Skip to content

Latest commit

 

History

History
110 lines (70 loc) · 3.46 KB

CONTRIBUTING.md

File metadata and controls

110 lines (70 loc) · 3.46 KB
Raw

Contribution Guideline

Things to note before contributing

  • Make sure that the contribution you seek to make is not the iteration of a former issue or hasn't been done by anyone else.
  • If you face with a problem, open up an issue for it.
  • For a change you await or want, open up an issue.
  • Open up an issue in order to add a new feature.
  • Create a PR to fix an issue.
  • Create a PR to fix an error in the documentation.

PR Rules

Issue Rules

Before you begin

Setting up the project

Requirements:

  • Node 17.0^
  • Yarn 1.22^
# Clone the project
git clone

# Move to project directory
cd deprem-yardim-frontend

# Copy sample environment file to development environment file
cp .env.sample .env.development

# Install the dependencies
yarn

# Run the development environment
yarn dev

Formatting the code

We use prettier on this project for code formatting. Linter configuration can be found here.

Commit messages

Each commit must include a header, a body and a footer. Title is formatted as type, scope and, description.

<type>(<scope>): <description>
<EMPTY LINE>
<body>
<EMPTY LINE>
<footer>

Commit messages should not exceed 72 characters.

Message header

Message header is mandatory and it must include a type, an optional scope and a short description. Ideally, it should not exceed 50 characters.

By complying with these rules, you can create an open change log for all versions.

It is advised to watching PR header for commit messages. This way, when a PR is merged, PR header can be used as commit message and allows the change history to be formatted appropriately.

Type

Type states the type of your change. Allowed types are:

  • feat: Adds a new feature
  • fix: Fixing an error/bug
  • docs: Changes that affect only the documentation
  • style: Just formatting changes such as punctuation, spaces etc.
  • refactor: A change that does not affect the contents of the code
  • perf: Performance change
  • test: Adds missing tests or changes current ones
  • chore: Other changes that does not affect the development process

Scope

Scope, states the part that is affected by the commit. For instance, a scope such as kafka or login can be stated.

Description

Description provides a short explanation regarding the purpose of the commit. First letter should be capitalized. Description should be one sentence. This could serve as the commit message header.

Message Body

Message body is an explanation that states why the commit was made. Body can be one or more paragraphs. Paragraphs should not exceed 72 characters.

More info for writing git commit messages

Message Footer

Completed, fixed or delivered cases should be added to footer as a separate line and start with "Finishes", "Fixes" or "Delivers" keyword:

[(Finishes|Fixes|Delivers) #ISSUE_ID]

Message Sample

feat(34): implement exactly once delivery
- ensure every event published to kafka