Contribute

Getting started

Before contributing to TaskCollect, you should familiarise yourself with the relevant parts of the source code, the contributing guidelines, and our contribution process. In particular, three items are of note:

Once you have accustomed yourself to the way our workflow runs, you can send your first patch!

Creating your patch

Thanks to our patch-based workflow, you do not need to switch to a new branch to start making changes to the codebase. (You can if you prefer, but this is not a requirement of the process). Simply start making changes to the source code on the branch you are on (or a different one if you so choose), and when you have made a single meaningful change that compiles, runs, and works more or less as intended, make sure to commit. In general, your commit messages should look somewhat like this: 

src/server/auth.go: use true random number generator

Or like this for detailed commit messages: 

all: remove python dependency

Removed the Python build script. All building and running processes
are now handled by the makefile.
		
Also removed the notion of "installing" TaskCollect - the TaskCollect
server now uses the resources folder within the local cloned
repository rather than invading the user's home directory.

You will need to sign off your commits with git commit -s to indicate that you have read and agree with the Developer Certificate of Origin.

You should consult the contributing guidelines for a definitive guideline on how you should commit your changes.

Sending your patch

To send your patch to us, you will need to use git send-email. There is a guide available online which you should consult before sending us a patch for the first time. This contribution method uses email, so make sure you send your patch from an email address that you are comfortable with being publicly visible.

Make sure to send your patch to ~kvo/taskcollect-devel@lists.sr.ht. Also, please ensure your patch email subject follows the same naming conventions as those for commit messages, as the subject line becomes the commit message.