Proofread docs in the /contributing directory #1718
Conversation
teslazonda
changed the title
|
|
||
| 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: |
There was a problem hiding this comment.
Should we recommend making pull requests against the current branch?
| * 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. |
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?
| enhance it or if you don't find one, create a new one by use the quick link in | ||
| the left side under the specific project. | ||
| Have an idea to improve VyOS or need a feature that would benefit all users? | ||
| Before submitting a feature request, search Phabricator_ to check if a request |
There was a problem hiding this comment.
| Before submitting a feature request, search Phabricator_ to check if a request | |
| Before submitting a feature request, search the public issue tracker (vyos.dev) to check if a request |
It's a Phorge installation rather than the old, now-unmaintained Phabricator. We may want to avoid mentioning that since it doesn't say "Phorge" prominently anywhere and few people mentally associate vyos.dev with "Phorge" in any case.
| testing works. | ||
| This section describes how the automated testing process at VyOS works. | ||
|
|
||
| Jenkins CI |
There was a problem hiding this comment.
This section is very outdated — our CI has been based on GitHub Actions for a couple of years already. Since it has nothing to do with the way people can run tests, we may want to remove this section altogether, then we can eventually give an overview of the current CI somewhere else.
2 participants
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: