Add development_guidelines.md for both human and machine
#9696
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
yyforyongyu
added
documentation
|
Important Review skippedAuto reviews are limited to specific labels. 🏷️ Labels to auto review (1)
Please check the settings in the CodeRabbit UI or the You can disable this status message by setting the Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
There was a problem hiding this comment.
Copilot reviewed 4 out of 4 changed files in this pull request and generated no comments.
Comments suppressed due to low confidence (3)
docs/code_formatting_rules.md:1
- Since this file has been removed, please ensure that all references to docs/code_formatting_rules.md elsewhere in the repository have been updated to point to the new development guidelines file.
# Code formatting rules
.github/pull_request_template.md:15
- Verify that the section 'code-documentation-and-commenting' exists in the new development_guidelines.md file, and update the link if needed.
- [ ] The change obeys the [Code Documentation and Commenting](https://github.com/lightningnetwork/lnd/blob/master/docs/development_guidelines.md#code-documentation-and-commenting) guidelines, and lines wrap at 80.
docs/code_contribution_guidelines.md:141
- Ensure that any test coverage guidelines previously found in the Testing section are adequately referenced or integrated into the new consolidated development guidelines, to avoid missing test requirements.
## Development Guidelines
guggero
approved these changes
Apr 11, 2025
bitromortac
approved these changes
Apr 14, 2025
docs/development_guidelines.md
Outdated
| Blocks of code within `lnd` should be segmented into logical stanzas of | ||
| operation. Such spacing makes the code easier to follow at a skim, and reduces | ||
| unnecessary line noise. Coupled with the commenting scheme specified in the | ||
| [contribution guide](./code_contribution_guidelines.md#code-documentation-and-commenting), |
There was a problem hiding this comment.
That link broke, we can just keep the # part, as this references a section in this doc
There is also a line that needs update in review.md, I think:
- Is the flow of the commits easy to understand? Does the order make sense?
See the [code development
guidelines](docs/development_guidelines.md#ideal-git-commit-structure) for
more information on this.
I'm not sure if this needs to be relative to the root dir or relative to docs.
This file focuses on the requirements and steps needed to make an acceptable PR.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 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.
When running aider I'd use both
code_contribution_guidelines.mdanddocs/code_formatting_rules.mdas the convention file, while only a portion ofcode_contribution_guidelines.mdis used, which can waste tokens.This PR moves all the coding related requirements into one file to guide aider, so one can add the line to its config,
The
## Testingsection is expanded with details on how to run the unit test, so the aider will produce sth like,