Contributing

Information on how you can help contribute to CookieCraft. You can find open issues on our bug tracker or look at our to-do list page.

Setup Your Environment

For this repo we use Nix to make tooling easy. All you have to do is install Nix and run nix-shell in the project directory to have all the tools required for this repo working.

Then, to install the git hooks, you can just run just setup.

If you choose to not use Nix, you will have to install all the dev tools manually.

Currently this project uses these tools:

Then, to install the git hooks, you can just run just setup.

Documentation

This project uses mkdocs to build the wiki. This means that you can just edit the documentation using Markdown. Once you make your chanages, you can preview the changes by running just serve-docs and going to http://127.0.0.1:8000.

Code

This project uses very little code. It is mainly the documentation, config files, and tools to make those things easier. The main area you help help by coding is the things like the workflows and just scripts. If you see any issues with them, or you think there is a way to improve them, feel free to open up an issue on our bug tracker to discuss it.

Financially

Last, but certainly not least, you can support the project by donating to me, @ArkhamCookie.

Direct Donation

You can really help me by sending a donation my way. I love open source and creating projects to share with the world, and I hope to make it my full time job eventually.

Even a "small" amount, like one dollar, goes a long way; both to feed my cookie addiction and help motivate me. There's nothing quite like knowing someone enjoys your work.

You can find me on:

The best way is through Ko-fi because they take a 0% fee of all donations, memberships, commissions, etc. No matter how you choice to support me, I greatly appreciate it.

Hire Me

I currently do freelance work. If you are in need of a developer, contact me at hire-me@mail.arkhamcookie.com.

I am always looking for new people to work with and new problems to solve.

Website

Speaking of freelance work, one of the things I commonly do is design websites. If you are a fan of my work and want something in return, hiring me to design your website is a great way to support me.

I can set up hosting on the hosting provider of your choice or set you up on a site, like GitHub, for free hosting.