dumb-init/CONTRIBUTING.md
2015-09-18 11:23:26 -07:00

1.1 KiB

Contributing to dumb-init

dumb-init is primarily developed by Yelp, but contributions are welcome from everyone!

Code is reviewed using GitHub pull requests. To make a contribution, you should:

  1. Fork the GitHub repository
  2. Push code to a branch on your fork
  3. Create a pull request and wait for it to be reviewed

Releasing new versions

dumb-init uses semantic versioning. If you're making a contribution, please don't bump the version number yourself—we'll take care of that after merging!

The process to release a new version is:

  1. Update the version in setup.py
  2. Update the Debian changelog with dch -v {new version}.
  3. Update the wget url in the README to point to the new version.
  4. Commit the changes and tag the commit like v1.0.0.
  5. git push --tags origin master
  6. Run rm -rf dist && python setup.py sdist to create a source distribution
  7. Run twine upload dist/* to upload the new version to PyPI
  8. Run make builddeb-docker and upload the resulting Debian package to a new GitHub release