Skip to content

Latest commit

 

History

History
105 lines (66 loc) · 5 KB

CONTRIBUTING.md

File metadata and controls

105 lines (66 loc) · 5 KB
Raw

How to contribute to this project ?

summary :

Choose an issue :

You must choose an issue on the project github. If you want to do something but no issue is created yet you must create one (try to tag it properly).

Fork the project :

You need to fork scratchy repository

Create your branch :

Create a new branch with the following name : ISSUEID-title_of_issue

  • example : 91-create_scratchy_service

Create an issue :

ℹ️Github issue guide

  1. Choose a implicite title (max ~ 13 words), your title must be begin by a tag.

    tags have same name of labels (Front,Back,Doc,Bug,Help...)

  2. Write a good description with much details as possible

  3. Assign your issue to yourself if you want to solve it or wait for someone to assign it

  4. Add labels, for example in scratchy service issue (picture) we use frontend and enchancement labels. see all labels here and their meaning

  5. Add your issue to a project the current one (V1) if it is important or the next one if not because in the future we will go over V2

  6. Add your issue to the current one milestone if it is important or the next one.

  • Example : [example] Create scratchy service that contains methods for backend requests access example issue

Create a pull request :

When you think your code is ready to be merged to the project create a pull request.

  1. Choose the title: patern: ISSUEID title of the issue (if you have respected the naming branch pattern the title will be good automatically)

    If you want to make a pull request to add new features but you don't have an issue, you must be create an issue and in them explain what you want add,resolves... Finally after you have resolved her you can push your pull request respecting issue and pull request template.

  2. Make a great description : Please write a pull request description like with :

  • the id of the issue resolved with a keyword to link to the coresponding issues

    ℹ️ how to link a issue and use the keywords(Fixes,resolves...)

  • a message who say what you add or do in your pull request.

  1. Assign it to yourself

  2. Add labels, for example in scratchy service issue (picture) we use frontend and enchancement labels. see all labels here and their meaning

  3. Add your issue to a project the current one (V1) if it is important or the next one if not because in the future we will go over V2

  4. Add your issue to the current one milestone if it is important or the next one.

  5. If it's work in progress, set the pull request status to draft After, set your pull request status to open, wait for a reviewer who approve your code. If the reviewer request change make them and request review again. To finish if the revewier approve your code, the code owner will squash and merge your commits in pull request to main branch

  • Example : [example] Create scratchy service that contains methods for backend requests access example issue

What are the requirement for proposing a pull request ?

  • There are the convention to respect for each programing language

    Language Convention
    Python PEP8
    YAML The linter

  • Other important notes

    • comments : Please comment your code in a clear way (we don't ask for a novel but someone who read your code must be able to tell what it does)