From b36b4e2fde2c76958880bad27ba1d1a44fdf320d Mon Sep 17 00:00:00 2001 From: James Falcon Date: Mon, 22 Nov 2021 17:17:26 -0600 Subject: docs: Rename HACKING.rst to CONTRIBUTING.rst (#1118) 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. --- doc/rtd/index.rst | 2 +- doc/rtd/topics/contributing.rst | 2 ++ doc/rtd/topics/hacking.rst | 2 -- 3 files changed, 3 insertions(+), 3 deletions(-) create mode 100644 doc/rtd/topics/contributing.rst delete mode 100644 doc/rtd/topics/hacking.rst (limited to 'doc') diff --git a/doc/rtd/index.rst b/doc/rtd/index.rst index 69cf2068..251a904d 100644 --- a/doc/rtd/index.rst +++ b/doc/rtd/index.rst @@ -68,7 +68,7 @@ Having trouble? We would like to help! :titlesonly: :caption: Development - topics/hacking.rst + topics/contributing.rst topics/code_review.rst topics/security.rst topics/debugging.rst diff --git a/doc/rtd/topics/contributing.rst b/doc/rtd/topics/contributing.rst new file mode 100644 index 00000000..c9e88dbb --- /dev/null +++ b/doc/rtd/topics/contributing.rst @@ -0,0 +1,2 @@ +.. include:: ../../../CONTRIBUTING.rst +.. vi: textwidth=78 diff --git a/doc/rtd/topics/hacking.rst b/doc/rtd/topics/hacking.rst deleted file mode 100644 index 5ec25bfb..00000000 --- a/doc/rtd/topics/hacking.rst +++ /dev/null @@ -1,2 +0,0 @@ -.. include:: ../../../HACKING.rst -.. vi: textwidth=78 -- cgit v1.2.3