Contributing

⚖️ Code of Conduct

By participating in contribution, you are expected to uphold this Code of conduct adapted from Contributors Convenant v2.0

🛠️ Contribution Principles

1️⃣ Fork the project to your computer

git clone https://github.com/Crypto-Link-Payments/crypto-link.git

2️⃣ Branch naming requirements

In order to make contribution easier for everyone each branch naming title needs to be readable and follow principles presented below:

# Branch name constructs

<type>/<area>-<action>

Available type options:

• improvement

• bug

• feature

Available area options:

• Docs => Used when providing modifications/improvements or upgrades to documentation

• Discord => Used when providing modifications/improvements or upgrades to part of the code (cogs folder)

• Backend => Used when making modifications/improvements or upgrades to backend files (mainly backend folder)

• Multi => Due to interconnection of scripts and development objectives modifications are required to be done to backend and cogs

Available action options:

Custom description with maximum 3 words separated by -

Example of creating the branch by following principles above

git checkout -b docs/discord-owner-cmds

3️⃣ PR naming and description

Try to be "on-point" with the title of the pull request so it can be clearly identified what it is all about. In its description provide as many details as possible on what you have worked on and make the reviews easier for maintainers.