This is a guide for all possible badges. For your particular project, please go to the readme guide for the badges you need to include in your project. Although it is highly recommended that you use the badges mentioned in this guide.
Badges are an important indicator as to code, build, and release quality. These should give the end user an accurate representation as to the state of your code and put them at ease about installing and using your SDK and module with their project.
-
To use a Github actions badge, you will need to copy your repo path to the workflows folder and yaml file:
-
Example with a particular branch:
- This badge gets its validation from the name portion of the
ci.yamlfile which isCI
- This badge gets its validation from the name portion of the
-
Example for master build:
-
With Github Actions, you can also document multiple badges for different worfklows, such as release, testing, etc.
-
Example:
-
This allows a user who is looking at the documentation repo to know the stages that are passing.
-
Go to bettercodehub.com
-
Click on the
Sign in with GitHubbutton -
Log in with your
GitHubaccount -
You should now see any organizations you belong to, including your own GitHub
-
Click on the XYO Logo
-
You should now be able to search for your project
If your project does not have a numerical score
-
Then click on the
playbutton to analyze the repository -
Once the analysis is complete you should see a numerical score
-
You should also see a series of icons that indicate successful or failed checks
Once you have completed and verified the analysis of your project
-
Click on the
settingswheel -
You should see a compliance badge with your score out of 10
-
There are two methods to get the badge, we want to grab the markdown version
-
Copy the markdown version and paste it in the readme for your repository
Check in with Phillip Lorenzo or Arie Trouw the current admins for these services. They will decide whether to give you permission to generate the badges, or whether admin would need to generate and place in documentation.
Your project will be complete and to standard once you have placed these badges in your documentation and README.md file
Markdown may be taken for granted in a project's readme or getting started guide, but to pass Codacy's guidelines and to have a clean markdown file, it is a good idea to use the remark code style linter.
For reference to this linter, click here
To use the remark linter cli (which we strongly recommend), install with the global tag
npm install -g remark-cliCreate an empty .remarkrc file, especially if your project is not in node.js
.remarkrc
{
// keep this empty
}
Then run the remark command either for one file or for an entire project:
remark [your-file-name].mdor for the whole file
remark . Once the command is executed you should get feedback indicating no issues:
README.md: no issues found
bestpractices/badge-setup.md: no issues found
bestpractices/c-c++.md: no issues found
bestpractices/developer-guide.md: no issues found
bestpractices/java-kotlin-android.md: no issues found
bestpractices/nodejs.md: no issues found
bestpractices/objectivec-swift-ios-osx.md: no issues found
bestpractices/readme-guide.md: no issues found
repositories/applications.md: no issues found
repositories/dapps.md: no issues found
repositories/documentation.md: no issues found
repositories/pipeline.md: no issues found
repositories/sdks.md: no issues found
repositories/tools.md: no issues foundYou can also run remark using the VSCode extension. There are instructions on how to do use this click here
Once you have taken this step, your repo should be free of any unecessary markdown issues when running through the Codacy check.