Skip to content

docs: Rename HACKING.rst to CONTRIBUTING.rst (SC-501)#1118

Merged
blackboxsw merged 1 commit into
canonical:mainfrom
TheRealFalcon:contributing-doc
Nov 22, 2021
Merged

docs: Rename HACKING.rst to CONTRIBUTING.rst (SC-501)#1118
blackboxsw merged 1 commit into
canonical:mainfrom
TheRealFalcon:contributing-doc

Conversation

@TheRealFalcon
Copy link
Copy Markdown
Contributor

Proposed Commit Message

docs: Rename HACKING.rst to CONTRIBUTING.rst

This is more consistent with other github repositories, and will prompt
a first-time contributor to read the contributing guidelines before
submitting the pull request.

Additionally, added a summary section to the top, updated some outdated
language, and removed some outdated typing guidance.

Additional Context

The net refactor stuff seems a bit out of place here, but I didn't move it because there's not an immediately better place to put it, and I think it can be easily ignored for somebody not interested.

This is more consistent with other github repositories, and will prompt
a first-time contributor to read the contributing guidelines before
submitting the pull request.

Additionally, added a summary section to the top, updated some outdated
language, and removed some outdated typing guidance.
@TheRealFalcon TheRealFalcon changed the title docs: Rename HACKING.rst to CONTRIBUTING.rst docs: Rename HACKING.rst to CONTRIBUTING.rst (SC-501) Nov 22, 2021
Copy link
Copy Markdown
Member

@holmanb holmanb left a comment

Choose a reason for hiding this comment

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

Looks good

Copy link
Copy Markdown
Collaborator

@blackboxsw blackboxsw left a comment

Choose a reason for hiding this comment

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

+1 bring it home

Comment thread CONTRIBUTING.rst
the codebase is encouraged but with one important caveat: types from
the ``typing`` module cannot be used.

cloud-init still supports Python 3.4, which doesn't have the ``typing``
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Woo hoo victory lap on dropped Python 3.4.

@blackboxsw blackboxsw merged commit b36b4e2 into canonical:main Nov 22, 2021
@TheRealFalcon TheRealFalcon deleted the contributing-doc branch November 22, 2021 23:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants