Repository navigation
developer-guide: add contribution workflow - #1151
Merged
Merged
Conversation
jklare
force-pushed
the
developer-guide-contribution-workflow
branch
from
November 19, 2026 09:57
3b08a43 to
20998c0
Compare
✅
|
| Descriptor | Linter | Files | Fixed | Errors | Max errors | Warnings | Elapsed time |
|---|---|---|---|---|---|---|---|
| ✅ ACTION | actionlint | 5 | 0 | 0 | 0.04s | ||
| ✅ JSON | jsonlint | 4 | 0 | 0 | 0.06s | ||
| ✅ JSON | prettier | 4 | 0 | 0 | 0.24s | ||
| ✅ JSON | v8r | 4 | 0 | 0 | 5.27s | ||
| ✅ MARKDOWN | markdownlint | 184 | 0 | 0 | 1.99s | ||
| ✅ MARKDOWN | markdown-table-formatter | 184 | 0 | 0 | 0.23s | ||
| ✅ REPOSITORY | betterleaks | yes | no | no | 0.58s | ||
| ✅ REPOSITORY | checkov | yes | no | no | 11.4s | ||
| ✅ REPOSITORY | git_diff | yes | no | no | 0.05s | ||
| ✅ REPOSITORY | secretlint | yes | no | no | 1.04s | ||
| ✅ REPOSITORY | trufflehog | yes | no | no | 2.61s | ||
| ✅ SPELL | codespell | 194 | 0 | 0 | 0.35s | ||
| lychee | 190 | 1 | 0 | 28.41s | |||
| ✅ YAML | prettier | 6 | 0 | 0 | 0.29s | ||
| ✅ YAML | v8r | 6 | 0 | 0 | 4.48s | ||
| ✅ YAML | yamllint | 6 | 0 | 0 | 0.31s |
Detailed Issues
⚠️ SPELL / lychee - 1 error
📝 Summary
---------------------
🔍 Total.........1302
🔗 Unique.........957
✅ Successful....1183
⏳ Timeouts.........2
🔀 Redirected.......1
👻 Excluded.......116
❓ Unknown..........0
🚫 Errors...........1
⛔ Unsupported......1
Errors in docs/guides/developer-guide/style-guide.md
[ERROR] https://wiki.openstack.org/wiki/GitCommitMessages (at 79:1) | Network unreachable. Check internet connection or VPN settings
Errors in docs/guides/user-guide/openstack/migration-vmware-esxi.md
[TIMEOUT] https://hystax.com/cloud-migration/ (at 15:1) | Request timed out
Errors in docs/guides/user-guide/openstack/openstackclient.md
[TIMEOUT] https://adam.younglogic.com/2022/03/generating-a-clouds-yaml-file/ (at 137:9) | Request timed out
Hint: Followed 1 redirect. You might want to consider replacing redirecting URLs with the resolved URLs. Use verbose mode (`-v`/`-vv`) to see redirection details.
See detailed reports in MegaLinter artifacts
Your project could benefit from a custom flavor, which would allow you to run only the linters you need, and thus improve runtime performances. (Skip this info by defining FLAVOR_SUGGESTIONS: false)
- Documentation: Custom Flavors
- Command:
npx mega-linter-runner@10.2.0 --custom-flavor-setup --custom-flavor-linters ACTION_ACTIONLINT,JSON_JSONLINT,JSON_V8R,JSON_PRETTIER,MARKDOWN_MARKDOWNLINT,MARKDOWN_MARKDOWN_TABLE_FORMATTER,REPOSITORY_CHECKOV,REPOSITORY_GIT_DIFF,REPOSITORY_BETTERLEAKS,REPOSITORY_SECRETLINT,REPOSITORY_TRUFFLEHOG,SPELL_LYCHEE,SPELL_CODESPELL,YAML_PRETTIER,YAML_YAMLLINT,YAML_V8R

Show us your support by starring ⭐ the repository
jklare
force-pushed
the
developer-guide-contribution-workflow
branch
3 times, most recently
from
November 19, 2026 10:13
9d8c439 to
7aac3b6
Compare
The developer guide only had a paragraph that pointed contributors to GitHub's pull request documentation. The rest of the process was spread over the style guide (commit messages) and the Zuul CI page, and some of it was not written down anywhere, such as where to branch, which linters CI runs and who merges a pull request. Replace that paragraph with a "Contribution workflow" section that lists the steps in order: 1. Open an issue in the repository where the problem exists. Use osism/issues only if it is not yet clear which repository is affected, or if several repositories are affected. 2. Create a branch: external contributors use a fork, OSISM team members push to the repository in the osism organization. 3. Commit, following the commit message guidelines. This step also points out our rules for transparency about AI assistance: an AI-assisted change gets an Assisted-by trailer naming the assistant, and Signed-off-by, from the responsible person, stays the last line and is never used for an AI assistant. It links to the full rules in the style guide. 4. Open a pull request against the default branch. 5. Pass the CI checks, including the zuul label for long-running jobs. This step names the linters the checks run (ansible-lint, yamllint, flake8, python-black, mypy, hadolint, depending on the repository) and where their configuration files are. Whether to run them locally is left to the contributor. 6. Review and merge: at least one OSISM maintainer approves, and that maintainer also merges. The section does not say when the merge happens, because that can depend on ongoing release processes. The steps link to the existing style guide and Zuul CI pages instead of repeating them. The two GitHub documentation links now point to their current URLs instead of the old ones that redirect. The page intro said that the issue tracker is osism/issues and linked "open an issue" straight to osism/issues/issues/new. Update it to the same rule as step 1. This also removes that link, which redirects visitors who are not logged in to the GitHub login page. The intro also says that we can only fix problems we know about, to encourage reporting issues even if they seem minor. Assisted-by: Claude:claude-opus-5-5 Signed-off-by: Jan Klare <klare@osism.tech>
jklare
force-pushed
the
developer-guide-contribution-workflow
branch
from
November 19, 2026 10:17
7aac3b6 to
379ccae
Compare
osfrickler
approved these changes
Nov 19, 2026
osfrickler
left a comment
Member
There was a problem hiding this comment.
lgtm, waiting a bit with merging to give others a chance to give feedback, too
ideaship
approved these changes
Nov 19, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The developer guide only had a paragraph that pointed contributors to GitHub's pull request documentation. The rest of the process was spread over the style guide and the Zuul CI page, and some of it was not written down anywhere.
This PR replaces that paragraph with a Contribution workflow section in
docs/guides/developer-guide/index.md. It lists six steps in order:osismorganization.Assisted-bytrailer naming the assistant, andSigned-off-by, from the responsible person, stays the last line and is never used for an AI assistant. It links to the full rules in the style guide.zuullabel for long-running jobs. This step names the linters the checks run (ansible-lint,yamllint,flake8,python-black,mypy,hadolint, depending on the repository) and where their configuration files are. Whether to run them locally is left to the contributor.The page intro said that the issue tracker is osism/issues and linked "open an issue" straight to
osism/issues/issues/new. It now states the same rule as step 1. This also removes that link, which redirects visitors who aren't logged in to the GitHub login page.The intro also says that we can only fix problems we know about, to encourage reporting issues even if they seem minor.
The steps link to the existing style guide and Zuul CI pages instead of repeating them. The linter list comes from the Zuul
checkpipelines of the OSISM repositories.Testing
documentationv10 image) pass.#commit-messages,#attribution-for-ai-assisted-changes,#pythonand#the-zuul-labelanchors.🤖 Generated with Claude Code