Remove the developer guide and link to CONTRIBUTING.md instead + some small updates#75
Draft
ihuguet wants to merge 6 commits intonmstate:mainfrom
Draft
Remove the developer guide and link to CONTRIBUTING.md instead + some small updates#75ihuguet wants to merge 6 commits intonmstate:mainfrom
ihuguet wants to merge 6 commits intonmstate:mainfrom
Conversation
Signed-off-by: Íñigo Huguet <ihuguet@riseup.net>
Signed-off-by: Íñigo Huguet <ihuguet@riseup.net>
Signed-off-by: Íñigo Huguet <ihuguet@riseup.net>
Signed-off-by: Íñigo Huguet <ihuguet@riseup.net>
The "Design" document reflects the original design and motivation of the project, but not everything is accurate. It should only be read because of the interest on the history of the project, not to understand its current state. The Python API document is not kept up to date. The beginning of the document explains it, but make it clear in the link in index.md too. Signed-off-by: Íñigo Huguet <ihuguet@riseup.net>
The contributing rules are documented in the main nmstate repository's CONTRIBUTING.md, anyway, as it is the natural place where new contributors look at. It is not worth it to have duplicated information, or worse, information that's only available in one of those two places. In addition, the content of the developer guide contained links to many helper scripts that were either outdated, personal scripts with hardcoded paths to Gris' home directory or both. None of the scripts offered much real value to new contributors. Signed-off-by: Íñigo Huguet <ihuguet@riseup.net>
jvaclav-rh
approved these changes
May 7, 2026
Comment on lines
-155
to
-178
| ### Commit message format | ||
|
|
||
| The commit message format should be: | ||
|
|
||
| ``` | ||
| section: brief description | ||
|
|
||
| Full descritption including root cause analyze, code workflow, test coverage. | ||
| ``` | ||
|
|
||
| Example: | ||
|
|
||
| ``` | ||
| ovsdb: Preserve the NM external_ids | ||
|
|
||
| For newly created OVS internal interface with customer external_ids, | ||
| the ovsdb plugin will remove the NM external_ids `NM.connection.uuid`. | ||
|
|
||
| The fix is read the current `NM.connection.uuid` before applying | ||
| configure and merge it with original desired state. | ||
|
|
||
| Integration test cases added. | ||
| ``` | ||
|
|
There was a problem hiding this comment.
We should probably mention this convention in the upstream CONTRIBUTING doc. Right now, it just has generic advice on how to write commits.
There was a problem hiding this comment.
We link to this file in CONTRIBUTING.md, we should clean those links up once this is merged.
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
2 participants
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.
BEFORE REVIEW / MERGING: this PR must be accompanied by another
PR improving CONTRIBUTING.md in the main repo. Wait until this PR
is available so you can review both at the same time.
The contributing rules are documented in the main nmstate repository's
CONTRIBUTING.md, anyway, as it is the natural place where new
contributors look at. It is not worth it to have duplicated information,
or worse, information that's only available in one of those two places.
In addition, the content of the developer guide contained links to many
helper scripts that were either outdated, personal scripts with
hardcoded paths to Gris' home directory or both. None of the scripts
offered much real value to new contributors.
Also, update some small pieces of information that were a bit outdated
and add more clarifications about documents that are not kept up to date.