jesse-l / door-counter Goto Github PK

The code is currently not an installable package, and ought to become one:

http://python-packaging.readthedocs.io/en/latest/minimal.html

• Add a setup.py file and set up
• Organize the code so that the root only contains setup.py, documentation and configuration
• Add an entrypoint

• In the issue tracker, open a new milestone v0.1
• and assign this issue to it.

Then open two more issues for things that can be easily done, assign them to the milestone.

For writing issues, make sure of the following:

• That there is something that can be completed in the issue. (that it's actionable)
  Many issues are too vague, and if you can't tell "when will this be done?"
  from reading it, you cannot complete the issue. That means you should close it instantly.

• Make sure that they are small enough to be solvable.
  "Take over the world" is actionable, (clear defined end) but too large to be practical.

For GitHub, Travis CI is the recommended

Set up a basic CI pipeline that:

• installs the application with pip install .

This is the "Hello World" verion of a CI system, but requires you to read up a bit on getting the basics running.

A minimal Travis setup looks like:

  language: python
  python:
    - 3.6
    - nightly
  script:
    - pip install -r requirements.txt
    - pip install .

A commit message has three parts:

Subject

should be <70 chars long, and describe what this commit does

Do not refer to issues in the subject, and do not mention filenames.
Mention areas of the code in the beginning. ("docs", "foomodule",)
After the subject there comes a blank line

Body

Should describe why this changes, in detail. Body of commits are what others will read to figure out why a change happens. If the body is not rationalizing why the code is changing, it's not doing it's job.

This can contain benchmarks, explanations, security considerations and other things.

After the body there comes a blank line

Tags

Tags refer to what tools parse from the message.
This can be "Signed-Off-By" which tracks copyright and authorship
This can be "Reviewed-By" which tracks code reviews
This can be "Reported-By" which tracks who found the bug you're fixing
This can be "Issue: #1" or "Fixes: #32" , or "Issue: #44" which refers to an issue in the issue tracker.

Github automatically tracks some of these to link code => issue, and can also automatically close issues, and notify bug-reporters when their issues get fixed.

Use these consistently.