Skip to content

Latest commit

 

History

History
77 lines (50 loc) · 2.41 KB

CONTRIBUTING.md

File metadata and controls

77 lines (50 loc) · 2.41 KB
Raw

Contributing

All code you commit and submit by pull-request should follow these simple guidelines.

Branching

Create a branch using the following naming prefixes:

f = feature

b = bug fix

d = documentation

t = tests

td = technical debt

v = dependencies ("vendoring" previously)

Some indicative example branch names would be f-update_assets_to_EDCv0.2.0 or td-staticcheck-st1008

Commit messages

Follow Conventional Commits standard.

Pull requests

  1. Open the pull request giving a title following Conventional Commits. Keep the title short (~50 characters). Always try to give a scope to the title.

Following this convention will help keep the repository in order and create sleek changelogs.

  1. Try to fill the pull request template as closely as possible. Provide a short description that answers these questions:
  • "how this pull request will change the code?"
  • "what is the purpose of these changes?"

Take the opporutnity to reflect on your learnings and share them with everyone else.

  1. For any task, try to provide a way to test its results; it would greatly help the QA process.

  2. Assign the pull request to yourself.

  3. Upon approval, you are in charge of merging the code back. It's crucial to own the code we create and ensure it is released. If you wish your code is merged upon approval, please, specify it in the pull request description.

  4. Upon merge (ndr. squash and merge), remember to delete the merged working branch; let's keep a clean repository.

New features & bug fixes

Within this project, we follow a Test-Driven Development (TDD) approach.

Unit Tests

  • To run the unit tests of the project, run the following command:
go test ./...
  • To run unit tests on a specific service, run the following command:
make test WHAT=path/to/folder

User Acceptance Tests (UATs)

Requisites

Before running UATs, you need to:

  • Install Docker in your machine.
  • Run EDC provider and consumer connectors, by running the following command:
docker-compose -f connector/docker-compose.yml up

Note: Ports needed by Docker containers should be available on your host machine

Run UATs

  • You can find User Acceptance Tests in the folder examples
  • Run UATs of a specific service by running the following command:
go run ./examples/assetsCrud/...