Skip to content

Latest commit

 

History

History
53 lines (34 loc) · 3.41 KB

CONTRIBUTING.md

File metadata and controls

53 lines (34 loc) · 3.41 KB

Contributing Guide

Contributing to the GitPy project is fairly easy. This document shows you how to get started.

Prerequisites

First of all, thank you for taking your time to contribute to this project ❤️

But before you start, verify that you meet the following prerequisites:

  • You have a code editor, a GitHub account, and experience using command-line programs, including git commands and command line options (CLI). You should also be familiar with the GitFlow workflow and Linux environment

  • You must read, agree and follow the Code of Conduct AND the Developer Certificate of Origin (DCO) in order to contribute to GitPy

  • There are a few guidelines that you must follow in order to ease the process of getting your contribution accepted. See DEVELOPING.md for more information

  • OpenPGP keys is used to sign the Git commits. If you don't know how to sign your commits, please read the GPG Signing page

Getting stared

  1. Open a new Contributing request issue template and fill it with the necessary information. Now you have to wait until the maintainer review your request and approve your proposed changes

  2. If your request is approved, you can fork the project by going on the GitPy fork page, and untick the Copy the master branch only option then click on the Create fork green button

  3. In your forked repo., create a new branch based on develop

Important

For the branch name, see the Branch Naming section for more information.

  1. After making the first changes, already open a Pull Request from your branch in the forked repo. TO the develop branch on the main repo. So we know that you're working on it and others people, and us, can help you if needed

    • In your PR, make sure to link the issue you created before in it's description for a better traceability

Important

Don't forget, in every commit you will make, to add the Signed-off-by footer trailer by appending the -s or --signoff option on the git commit command or manually add the footer on the commit message like this:

foo: baar

description

Signed-off-by: username <email> (keep the `<` and `>`)

  1. After you finished your changes and all test was made and all was successful, you can ping the maintainer (see the GitPy Development Team file, for the moment, astrdev is the only maintainer) on the PR and wait for the review. Don't spam him please, he will review your PR and give you a feedback as soon as possible

  2. When your PR is approved, it will be merged into the develop branch (on the main repo.) and will be available in the next release