This file provides general guidance for anyone contributing to IBM® RPA CLI project.
Commits must meet the following criteria.
Commit messages should follow the Conventional Commits pattern.
Following Developer's Certificate of Origin 1.1 (DCO), commit messages require Sign-off-by statements.
This is accomplished by using -s flag in the git commit -s command.
Different from the above, signed commits are also required. Understand the difference in the article Git commit signoff vs signing.
Learn how to sign commits in github Signing commits documentation.
It's not possible to merge Pull Requests (PR) through Github UI because this project uses a clean git history without merged commits and requires signed commits. Therefore, all PRs must be rebased-and-merged, but since Github cannot sign the rebased commits on your behalf - because Github does not have your key - this is not supported.
Merging commits manually is fairly easy:
git fetch -pgit checkout developgit pull origin developgit merge <pull-request-branch-name>git push origin develop
Use Visual Studio 2022 or VsCode to build and run the project locally. The main project is Joba.IBM.RPA.Cli.
Use Visual Studio 2022 or VsCode to run the test under Tests/ directory. Tests are also run as part of Pull Requests through build.yml workflow.
Create a signed tag - using -s option in git tag -s - and push it to the remote. This will start the release process using release.yml workflow.
The documentation uses docsify and it's automatically published whenever files changed within docs/ of gh-pages branch.