Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(contrib): Policy on manifest editing #12836

Merged
merged 1 commit into from
Oct 17, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions src/doc/contrib/src/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
- [New subcommands](./implementation/subcommands.md)
- [Console Output](./implementation/console.md)
- [Filesystem](./implementation/filesystem.md)
- [Formatting](./implementation/formatting.md)
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Didn't have a better idea of where to place this. Seemed too specific to be in the Design section. Figured that we can always move it in the future if we get better ideas on how we want to handle this.

- [Debugging](./implementation/debugging.md)
- [Tests](./tests/index.md)
- [Running Tests](./tests/running.md)
Expand Down
17 changes: 17 additions & 0 deletions src/doc/contrib/src/implementation/formatting.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# Formatting

When modifying user files, like `Cargo.toml`, we should not change other
sections of the file,
preserving the general formatting.
This includes the table, inline-table, or array that a field is being edited in.

When adding new entries, they do not need to match the canonical style of the
document but can use the default formatting.
If the entry is already sorted, preserving the sort order is preferred.

When removing entries,
comments on the same line should be removed but comments on following lines
should be preserved.

Inconsistencies in style after making a change are left to the user and their
preferred auto-formatter.