CONTRIBUTING

Cupcake Developer Guide

Welcome to the Contributing Guidelines for Cupcake. Your contributions and support are greatly appreciated! 🧡

Note You will need Git installed to follow the steps below!

Here are the basic steps needed to get set up and contribute a patch.

Fork the Cupcake repository to your GitHub account and get the source code using:

git clone https://github.com/<your_username>/Cupcake.git
cd Cupcake

We appreciate using a Release of Biscuit itself for development, but you can use your preferred editor. Open the project directory in your preferred environment.
Open an issue report in the issue tracker if the issue has not been reported/proposed yet.
Switch to a new local branch where your work for the issue will go (format it fix-# or feat-# if you are having trouble naming)
```
git checkout -b fix-123 main
```
Once you fixed the issue, try running the related examples, and check no errors are occuring, if everything is ok, commit with a proper message regarding what has been fixed.
You can run the changelog command (not mandatory, requires pip install git-changelog):
```
git-changelog -o CHANGELOG.md
```
This will update the changelog, and now commit the changes.
Push the branch on your fork on GitHub and create a pull request. Include fix: # in the description
```
fix: #123, Fix x bug in y module
```