Skip to content

Latest commit

 

History

History
72 lines (45 loc) · 2.67 KB

CONTRIBUTING.md

File metadata and controls

72 lines (45 loc) · 2.67 KB
Raw

CONTRIBUTING

## New Feature

check the wiki page https://github.com/foxmask/django-th/wiki to see if this one is on the roadmap

💡 open an issue to ask this feature, thus we will check if this one will match the main line of the project.

## New Module

check the wiki page https://github.com/foxmask/django-th/wiki to see if this one is on the roadmap

📦 To create a new module you can read the complet guide which describes the few thing to do.

Quick start :

just clone django-th-dummy and change 'dummy' to the name of your new module

or even faster :

just clone django-th-ansible, modify the site.yml file and run it and here you are !!! Your new module is ready

## Bug Fixing

❗ You can pick one of the issue. The sort order can be in priority, the issues that remain to be closed for a given milestone, then the issues tagged as "bug".

## Pull Request

❓ Create first an issue, thus we will check if this can be included in a next or new milestone

## Development

✨

  1. first of all, clone the project
  2. create a new branch for the issue you want to fix or the new module you want to make.
  3. if its :
  4. a new module/feature, checkout the master branch
  5. a bug fixing, checkout the branch on which this bug occurs
  6. commit and push to your cloned repository
  7. make a Pull Request
  8. wait patiently ;)

## Issue labels

some explanation on the labels of the issues

  • up-for-grabs : for new users that have never been involved in any other opensource project
  • start-with-label : this label tells you that you can start the module by cloning the django-th-dummy moduly
  • easy : this label tells you this issue is easy to fix
  • middle : this label tells you this issue is not complicate to fix, just take a little more time
  • hard : this label tells you this issue need you to know the core of the projet or a knwoledge of a new lib

## Unit Test

those are great to help to test how your code is working, and most of this, to check that your improvements dont break the existing code. All of them are in a test.py module on in a folder test/ that hosts several testing modules

To avoid to commit things that could fail, in the .git/hooks/pre-commit add this

#!/bin/bash
python manage.py test -v2
RESULT=$?
[ $RESULT -ne 0 ] && exit 1
exit 0

Thus, if the tests pass, the commit will be done and you could push without any problem.