Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.
You can contribute in many ways:
Report bugs at https://github.com/snakypy/dotctrl/issues.
If you are reporting a bug, please include:
- Your operating system name and version.
- Any details about your local setup that might be helpful in troubleshooting.
- Detailed steps to reproduce the bug.
Look through the GitHub issues for bugs. Anything tagged with "bug" and "help wanted" is open to whoever wants to implement it.
Look through the GitHub issues for features. Anything tagged with "enhancement" and "help wanted" is open to whoever wants to implement it.
Dotctrl could always use more documentation, whether as part of the official Dotctrl docs, in docstrings, or even on the web in blog posts, articles, and such.
The best way to send feedback is to file an issue at https://github.com/dotctrl/dotctrl/issues.
If you are proposing a feature:
- Explain in detail how it would work.
- Keep the scope as narrow as possible, to make it easier to implement.
- Remember that this is a volunteer-driven project, and that contributions are welcome :)
Ready to contribute? Here's how to set up dotctrl for local development.
Fork the dotctrl repo on GitHub.
Clone your fork locally:
$ git clone [email protected]:your_name_here/dotctrl.git
3. Install your local copy on a virtualenv. Assuming you have poetry installed, this is how you set up your fork for local development:
$ cd dotctrl/ $ poetry shell $ poetry install
Create a branch for local development:
$ git checkout -b name-of-your-bugfix-or-feature
Now you can make your changes locally.
5. When you're done making changes, check that your changes pass flake8, black and the tests:
$ poetry run tox
Commit your changes and push your branch to GitHub:
$ git add . $ git commit -m "Your detailed description of your changes." $ git push origin name-of-your-bugfix-or-feature
Submit a pull request through the GitHub website.
The Dotctrl project contains Dockerfile, so you can see how the development is going using a Python image.
To do this, do:
1 - Build:
$ docker build -t dotctrl:<version> .
2 - Access Dotctrl container in mode interactive:
$ docker run --rm -it dotctrl:<version>
3 - Run the command to create the Dotctrl repository:
$ mkdir -p /tmp/Dotfiles; cd $_ && dotctrl init
PyPI Publishing:
Different Python projects may use different versioning schemes based on the needs of that particular project, but all of them are required to comply with the flexible public version scheme specified in PEP 440 in order to be supported in tools and libraries like pip and setuptools.
Here are some examples of compliant version numbers:
1.2.0.dev1 # Development release
1.2.0a1 # Alpha Release
1.2.0b1 # Beta Release
1.2.0rc1 # Release Candidate
1.2.0 # Final Release
1.2.0.post1 # Post Release
15.10 # Date based release
23 # Serial releaseDotctrl uses semantic versioning, it is a 3-part MAJOR.MINOR.MAINTENANCE numbering scheme, where the project author increments:
The essence of semantic versioning is a 3-part MAJOR.MINOR.MAINTENANCE numbering scheme, where the project author increments:
- MAJOR version when they make incompatible API changes,
2. MINOR version when they add functionality in a backwards-compatible manner, and
- MAINTENANCE version when they make backwards-compatible bug fixes.
Adopting this approach as a project author allows users to make use of "compatible release" specifiers, where name ~= X.Y requires at least release X.Y, but also allows any later release with a matching MAJOR version.
Python projects adopting semantic versioning should abide by clauses 1-8 of the Semantic Versioning 2.0.0 specification.
For more information see: PyPI Publishing
If you contribute over 100 lines of code to the project, your name and some of your data will appear in the Dotctrl credits when run the command:
$ dotctrl --credits
Not only that, but your name will also appear in AUTHORS.rst. How about, huh?