docs: merge HACKING.md into CONTRIBUTING.md, fewer files in root - #2734
Open
benhoyt wants to merge 7 commits into
Open
docs: merge HACKING.md into CONTRIBUTING.md, fewer files in root#2734benhoyt wants to merge 7 commits into
benhoyt wants to merge 7 commits into
Conversation
This commit moves content without changing any of it (except appropriate adjustments of headings). - Setting up a dev environment: moved straight across - Testing: merged with "Tests" - Maintaining the documentation: merged with "Documentation" - Dependencies: moved to under "Pull requests" - Dev tools: merged with "Setting up a dev environment" - Releases: moved straight across - Updating the Charmcraft profiles: moved to a top-level section In addition, within the document: - Moved "Coding style" up to a sub-section under "Pull requests" I also added an extra blank line between top-level sections.
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
1 participant
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.
This PR makes several changes to reduce the number of files in the root directory of the repo.
Most significantly, it moves the content of
HACKING.mdintoCONTRIBUTING.mdwithout changing any of it (except minor adjustments to the headings):Within
CONTRIBUTING.md:In addition, the PR:
CODE_OF_CONDUCT.mdinto the.githubdir (GitHub still shows a tab).github.github(I know we're going to replace it soon, but no harm in the meantime -- we run it with tox.ini anyway)STYLE.md, as its content is now at https://github.com/canonical/charm-tech/tree/main/styleThe only change I'm not sure about is how I'm referencing the new style guides in AGENTS.md. Will agents pick those up?
NOTE: I plan a follow-up PR to clean up CONTRIBUTING.md a bit, as I think there's a bit of duplicate content there now, and probably some things that can be removed or shortened.
Fixes #2487