Contributing to C‐INS - inscription-c/cins GitHub Wiki

We always welcome and highly appreciate contributions to C-INS. To ensure efficient cooperation, we have some guidelines for you to follow.

Reporting Issues

For reporting issues, please search the issue list to see if a similar issue has already been reported. If not, you can create a new issue using the provided template .

In the issue template of bug, we will ask you to provide additional information about the bug, such as the steps to reproduce it and your operating system details. If possible, please include screenshots for clarification.

Requesting Features

For reqesting features, similar to reporting issues, first search the issue list, if it does not exist then create a new issue using the provided template .

In the issue template of requesting a feature, you should describe the feature you want, how you would implement it, and if we have any alternative ways to achieve the same goal.

Contributing Code

If you are interested in contributing code, we would greatly appreciate it! We use the Go language to implement C-INS. First and foremost, you should be familiar with Go and can build the C-INS Node on your own. After that, you can review the issues and pick one to work on. Start small and start quickly - we will be happy to help you.

When writing code, please follow the guidelines below:

• For code style, we are following the community standard of Go; it is not a strict requirement, and we are trying our best.
• For commit style, we are following Conventional Commits.
• For branch management, we are following some tailored Gitflow Workflow.