Skip to content

Latest commit

 

History

History
95 lines (67 loc) · 3.32 KB

CONTRIBUTING.md

File metadata and controls

95 lines (67 loc) · 3.32 KB
Raw

How to contribute

Table of contents

You should know how to use Github to contribute to this project. To learn, please follow these tutorials:

Now that you know how to use Github, we just follow the standard process like everybody else here: issues and pull requests.

General Discussion

Please make use of Doodba discussions to share knowledge, ideas or make questions.

There's one concrete channel for stuff specifically related to this template.

Issues

First of all, make sure your problem or suggestion is related to doodba-copier-template.

If that's the case, open an issue in our Github project. Read the instructions to know how to do it.

Propose Changes

Set up a Development Environment

To hack in this project, you need to set up a development environment. To do that, first make sure you have installed the essential dependencies:

Then, execute:

git clone https://github.com/Tecnativa/doodba-copier-template.git
cd doodba-copier-template
invoke develop

🎉 Your development environment is ready! Start hacking.

Know our Development Toolkit

Once you did the steps above, it will be good for you to know that our basic building blocks here are:

Open a Pull Request

You will have to choose the correct base to start developing your change:

  1. Base it on the devel branch if you're adding a new feature. This branch is intended to be the next feature or major release.
  2. Base it on the stable branch if you're fixing a bug. This branch only accepts that kind of patches. It is also updated from devel when a new bigger release is going to happen.

Follow Github's instructions to open a pull request.

After you've done that:

  1. We will review it ASAP.
  2. "ASAP" could be a long time; remember you don't pay us. 😉
  3. If it fits the project, we will possibly ask you to change some things.
  4. If it doesn't fit the project, we could reject it. Don't take it bad but maintaining stuff in the long term takes time... You can always use your own fork!