[#634] Update maintenance guides #676
Merged
Conversation
This file contains 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
PruStephan
force-pushed
the
PruStephan/update_documentation
branch
6 times, most recently
from
8b243a5 to
610a671
Compare
PruStephan
changed the title
PruStephan
force-pushed
the
PruStephan/update_documentation
branch
from
610a671 to
ffb767f
Compare
PruStephan
changed the title
krendelhoff2
requested changes
Aug 17, 2023
.github/CONTRIBUTING.md
Outdated
| @@ -28,12 +28,12 @@ otherwise improve our project, pull requests are most welcome. | |||
| - To stop building protocol-specific binaries for a protocol, but keep supporting it in | |||
| multi-protocol binaries, `./proto allow`. | |||
| - To deprecate a protocol, `./proto ignore ...`. | |||
|
|
|||
| - Note that this script is location sensitive, and required to be used from `scripts` folder | |||
There was a problem hiding this comment.
Suggested change
| - Note that this script is location sensitive, and required to be used from `scripts` folder | |
| - Note that this script is location sensitive, and required to be used from the `scripts` folder. |
krendelhoff2
approved these changes
Sep 4, 2023
| ### Nix specific maintenance | ||
|
|
||
| All nix related files are located in the [nix](../nix) directory. | ||
|
|
||
| If the build breaks because of a dependency issue, `nix repl pkgs.nix` | ||
| If the build breaks because of a dependency issue, `nix repl --extra-experimental-features repl-flake .#` | ||
| can be very useful to investigate it. | ||
|
|
||
| ## Legal |
There was a problem hiding this comment.
Update year in licensing information under Legal header please. Otherwise LGTM.
Problem: Maintenance docs in CONTRIBUTING.md contains some outdated information Solution: Add correct information, fixed existing mistakes.
PruStephan
force-pushed
the
PruStephan/update_documentation
branch
from
6dc6fcc to
29f84ce
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description
PR fixes small incorrectness in CONTRIBUTING.ml regarding maintenance.
Related issue(s)
Resolves #634
Related changes (conditional)
I checked whether I should update the README
I checked whether native packaging works, i.e. native binary packages
can be successfully built.
Stylistic guide (mandatory)