Skip to content

Latest commit

 

History

History
47 lines (28 loc) · 1.36 KB

CONTRIBUTING.md

File metadata and controls

47 lines (28 loc) · 1.36 KB

Contributing to py2peer

Thanks for taking the time and effort to make py2peer better for everyone.

This file contains a set of guidelines for contributing that we feel will make a project of the scope and size of py2peer more manageable and fun to work.

Table of Contents

tl;dr I just wanted to ask a question

How can I contribute?

Styleguides

tl;dr

@TODO: Add section.

How can I contribute?

@TODO: Add section.

Troubleshooting

Suggesting new features

Pull requests

Styleguides

PEP-8

All the code must be tested against a Python PEP-8 linter before commiting and pushing to this repository.

Common Python PEP-8 linters are pyflakes, flake8 and pylint. They are available for download and will work natively with the vast majority of IDEs out there.

Commit messages

  • You MUST NEVER use punctuation or symbols such as dots or hyphens as commit messages. The reasoning behind it is that if a bug should be found, commit messages that are indistinguishable from one another will make it harder to point to the defective commit, track and/or purge it from the tree.