Proofread docs in the /contributing directory #1718
Draft
Conversation
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
teslazonda
changed the title
teslazonda
commented
Dec 13, 2025
|
|
||
| Please submit your patches using the well-known GitHub pull-request against our | ||
| repositories found in the VyOS GitHub organisation at https://github.com/vyos | ||
| 6. Push to your fork and create a GitHub pull request: |
Contributor
Author
There was a problem hiding this comment.
Should we recommend making pull requests against the current branch?
teslazonda
commented
Dec 13, 2025
| * Python: Tabs **shall not** be used. Every indentation level should be 4 spaces | ||
| * XML: Tabs **shall not** be used. Every indentation level should be 2 spaces | ||
| * **Python**: Use 4 spaces per indentation level. Tabs **must not** be used. | ||
| * **XML**: Use 2 spaces per indentation level. Tabs **must not** be used. |
Contributor
Author
There was a problem hiding this comment.
Are there any other languages commonly used in VyOS that currently have internal coding guidelines? For example, C is used extensively in VyOS, what guidelines are there for C programming at VyOS?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Change Summary
Edited content in the
docs/contributingdirectory to align with the Microsoft Writing Style Guidetesting.rstbuild-vyos.rstupstream-packages.rstcla.rstdebugging.rstdevelopment.rstRelated Task(s)
Related PR(s)
Backport
Checklist: