Skip to content

How to start contributing

Welcome! We are glad that you want to contribute to our project! 💖

This project accepts contributions via Github pull requests.

This document outlines the process to help get your contribution accepted.

There are many ways to contribute:

You can start by looking through the good first issues.

Fork the repository

In general, we follow the "fork-and-pull" Git workflow.

Here's a quick guide:

  1. Create your own fork of the repository
  2. Clone the project to your machine
  3. To keep track of the original repository add another remote named upstream 
    git remote add upstream git@github.com:equinor/template-fastapi-react.git
  4. Create a branch locally with a succinct but descriptive name and prefixed with change type. 
    git checkout -b feature/my-new-feature
  5. Make the changes in the created branch.
  6. Add and run tests for your changes (we only take pull requests with passing tests). 
    docker compose run --rm api pytest
docker compose run --rm web yarn test
  7. Add the changed files 
    git add path/to/filename
  8. Commit your changes using the conventional commits formatting for the commit messages. 
    git commit -m "conventional commit formatted message"
  9. Before you send the pull request, be sure to rebase onto the upstream source. This ensures your code is running on the latest available code. 
    git fetch upstream
git rebase upstream/main
  10. Push to your fork. 
    git push origin feature/my-new-feature
  11. Submit a pull request to the original repository (via Github interface). Please provide us with some explanation of why you made the changes you made. For new features make sure to explain a standard use case to us.

That's it... thank you for your contribution!

After your pull request is merged, you can safely delete your branch.

Code review process

The core team looks at pull requests on a regular basis. After feedback has been given we expect responses within three weeks. After three weeks we may close the pull request if it isn't showing any activity.