Skip to content

Latest commit

 

History

History
47 lines (32 loc) · 2.7 KB

CONTRIBUTING.md

File metadata and controls

47 lines (32 loc) · 2.7 KB
Raw

Contributing

Thank you for considering contributing to the Repokid project! Get started by reading development setup then look for something in our open issues that matches your interest and skillset (or file an issue for something if it doesn't exist yet). Please make sure to follow the guidelines outlined in submitting changes and consider joining our Gitter. Happy hacking!

Development Setup

Please follow the instructions in Repokid's getting started section. If you encounter any problems with the instructions please file an issue.

Issue Tags

First time contributors should consider tackling an issue marked with difficulty:newcomer first. These issues are relatively easy and a good way to get started.

We also have some issues tagged with help wanted. These issues are something we'd love help with and are a great way to get significantly involved with the project.

Submitting Changes

If you're adding something to one of our modules that are already covered by unit tests please add tests that exercise your change. We're working on adding unit tests for other modules and looking for help to get to 100% coverage.

Please also verify that the changes you've made work as expected locally.

Pushing New Versions to Pypi

For the majority of contributors, this will not be a huge factor, however, for those deploying new versions, the instructions are as follows:

  1. Ensure you have twine installed, this is part of the requirements file, so if you've installed via the recommended paths, you should be fine.

  2. Edit the version number present in the repokid/init.py:

     $ vim repokid/__init__.py

  3. Create a package for your newest version:

     $ python setup.py sdist

  4. Upload to Pypi using Twine:

     $ twine upload dist/*

Problems that can be found when creating new versions.

Pypi has a "known problem" with versions of the same title, for example, reuploading a failed attempt, or trying to patch over the top of a dist that has a file missing. This will result in a failure, and will require you to bump numbers again. As they are immutable, effectively. So version numbers can be used fairly liberally.

Context around using Twine:

Please refer to the "Why Should I Use This" section:

https://github.com/pypa/twine

Chat with our Developers

Our developers are in Gitter. Whether you're seeing a bug, thinking about a new feature, or wondering about a design decision drop by and ask!