gitea-sonarqube-bot/CONTRIBUTING.md

Contribution Guidelines

Table of Contents

• Contribution Guidelines
  • Table of Contents
  • Setup development environment
  • Build and Run
  • Testing
  • Release
  • Developer Certificate of Origin (DCO)

Setup development environment

# Build docker environment
docker build -t gitea-sonarqube-pr-bot/dev -f contrib/Dockerfile contrib

# Start the environment
docker run --rm -it -p 49182:3000 -v "$(pwd):/projects" gitea-sonarqube-pr-bot/dev

Build and Run

# Build the binary
make build
# Start the server
make run

# or all in once
make build run

Testing

make test
# or
make coverage

Release

For local purposes

docker build -t gitea-sonarqube-pr-bot/prod .

Developer Certificate of Origin (DCO)

I consider the act of contributing to the code by submitting a Pull Request as the "Sign off" or agreement to the certifications and terms of the DCO and MIT license. No further action is required. Additionally, you could add a line at the end of your commit message.

Signed-off-by: Joe Smith <joe.smith@email.com>

If you set your user.name and user.email git configs, you can add the line to the end of your commit automatically with git commit -s.

I assume in good faith that the information you provide is legally binding.