GitHub Docs - Githubissues

milosmns commented 7 months ago

Summary

Updating the GitHub-based docs such as README, CONTRIBUTING, LICENSE, etc.

Resolves #70.

Change types

Including all that apply:

[ ] New feature (non-breaking change which adds functionality)
[ ] Bug fix (non-breaking change which fixes an issue)
[ ] Breaking change (fix or feature that would cause existing functionality not to work as before)
[ ] Refactoring (improvements to the codebase that aren't necessarily bringing new functionality)
[X] Docs update (this change requires a documentation update)
[ ] CI/CD (automation pipeline changes)

Testing

N/A

Final checks

I have completed the following:

[x] I have followed the contribution guidelines.
[x] I have performed a self-review of my code and materials.
[x] I have commented my code in hard-to-understand areas.
[x] I have made the corresponding changes to the documentation.
[x] My changes generate no new warnings.
[x] I have added tests that prove my fix is effective or that my feature works.
[x] New and existing unit tests pass locally with my changes.
[x] Cloud CI build passes with my changes.

codacy-production[bot] commented 7 months ago

Coverage summary from Codacy

See diff coverage on Codacy

Coverage variation	Diff coverage
Report missing for 75bb28c844c3dc5704e70b9ee7ec8fbf43e93ba6[^1]	:white_check_mark: ∅

Coverage variation details

| | Coverable lines | Covered lines | Coverage | | ------------- | ------------- | ------------- | ------------- | | Common ancestor commit (75bb28c844c3dc5704e70b9ee7ec8fbf43e93ba6) | Report Missing | Report Missing | Report Missing | | | Head commit (6cbd2dca6f8475ecaf8931e8c3500903bc406ab9) | 4149 | 3739 | 90.12% | **Coverage variation** is the difference between the coverage for the head and common ancestor commits of the pull request branch: ` - `

Diff coverage details

| | Coverable lines | Covered lines | Diff coverage | | ------------- | ------------- | ------------- | ------------- | | Pull request (#162) | 0 | 0 | **∅ (not applicable)** | **Diff coverage** is the percentage of lines that are covered by tests out of the coverable lines that the pull request added or modified: `/ * 100%`

See your quality gate settings Change summary preferences

_{You may notice some variations in coverage metrics with the latest Coverage engine update. For more details, visit the documentation} [^1]: Codacy didn't receive coverage data for the commit, or there was an error processing the received data. Check your integration for errors and validate that your coverage setup is correct.

github-actions[bot] commented 7 months ago

Build 8675467988 complete for 676aa4eda683c45f78ded126ab7cb45d56df3b7e.

# Valid until a new build
docker pull appifyhub/service:latest_pr
docker pull appifyhub/service:1.2.0.pr_162