Skip to content

Latest commit

 

History

History
158 lines (116 loc) · 4.72 KB

CONTRIBUTING.md

File metadata and controls

158 lines (116 loc) · 4.72 KB
Raw

Contributing to idmsvc-frontend

Getting Started

The repository is using Github flow.

  • Fork the repository in your namespace.
  • Clone the repository locally.
  • Create a branch.
  • Add changes:
    • If you change the api, run make generate-api.
    • If you add a new view, update ./src/Routes.tsx file, and add your view in a new directory ./src/Routes/MyNewView, with the files MyNewView.tsx, MyNewView.scss and MyNewView.test.tsx.
    • If you add a new component, encapsulate in a new ./src/Components (shared) or in the Components directory of the view that it belongs to.
  • Check everything build: make build
  • Check locally by using: make run and be sure the backend is started too.
  • FIXME Depending on the frontend containerization Check it deploys and works in ephemeral by: make ephemeral-deploy
  • Add unit tests. See 99-testing.
  • Check unit tests and linters are pasing by make lint test
  • Rebase and push your changes, and create a MR or PR.
  • Update changes from the review until you get an ACK.
  • Merge your changes :)

See: Development docs.

Reporting bugs

  • Be sure you are using the last version of our service.
  • Please if you think this bug is a security issue, see SECURITY.md.
  • Else, before create a new issue, please search into the current issues to check if it already exists.

Then it looks a new bug, so please create a new issue and fill the next template.

### Description

Tell us a summary of the bug.

### Steps to replay

- I do action step 1.
- I do action step 2.
- I do action step 3.

What frequency you can replay the issue? (always / specific env / random)

### What is the observed wrong behavior

Tell us what is wrong.

### What is the expected behavior

Tell us what you were expecting instead of the wron behavior.

### Additional information

Please attach any further information such as:

- What commit did you observed this? `git rev-parse --short HEAD`
- What API version did you use? `(cd api; git rev-parse --short HEAD)`
- Copy & paste log blocks.
- Configuration that could impact.
- Any other additional information that could be useful to replay and
  analyse the issue.

Thank you for contributing to get a better software! we will study the issue as soon as possible!

Commit messages

Follow the conventional commits guidelines to make reviews easier and to make the VCS/git logs more valuable. The general structure of a commit message is:

<type>[(optional scope)]: <description>

[optional body]

[optional footer(s)]

for instance

fix(HMS-9999): response 201 when a domain is registered

This change modified the status code for a success response when it
registers a domain, returning a 201 (Created) status code, instead
of 200 (Ok).

Signed-off-by: Alejandro Visiedo <avisiedo@redhat.com>

For a commit that has a github issue scope, the title would be:

fix(9999): response 201 when a domain is registered

Further information:

  • Prefix the commit subject with one of these types:
    • build, ci, docs, feat, fix, perf, refactor, revert, test, style, chore, infra.
    • You can ignore this for "fixup" commits or any commits you expect to be squashed.
  • Append optional scope:
    • For a jira ticket for instance: 
      fix(HMS-9999): response 201 when a domain is registered
    • For a github issue for instance: 
      fix(9999): response 201 when a domain is registered
  • Commit title shouldn't start with a capital letter or end in a period.
  • Use the imperative voice: "Fix bug" rather than "Fixed bug" or "Fixes bug."
  • Try to keep the first line under 72 characters.
  • A blank line must follow the subject.
  • Breaking API changes must be indicated by
    1. "!" after the type/scope, and
    2. a "BREAKING CHANGE" footer describing the change. Example: 
      refactor(HMS-9999)!: drop support for Python 2

BREAKING CHANGE: refactor to use Python 3 features since Python 2
is no longer supported.

Automated builds (CI)

Each pull request must pass the automated builds.

Coding

See developer documentation.

Style

Run make prettier to align the format of your code.