Skip to content

A local-first personal finance app

add contribution docs to repo; add PR template with PR process docs link comment (#733)

Henry Bley-Vromana28f137bbd8c
diff --git a/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md b/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md
new file mode 100644
index 0000000000..0c9e29fa38
--- /dev/null
+++ b/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md
@@ -0,0 +1,2 @@
+<!-- The process for Actual Budget Community Documentation pull requests is documented at https://actualbudget.org/docs/contributing/#submitting-a-pull-request -->
+
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 0000000000..2f412f3574
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1 @@
+Please review the contributing documentation on our website: https://actualbudget.org/docs/contributing/
diff --git a/README.md b/README.md
index 987948abf4..7bff91e73e 100644
--- a/README.md
+++ b/README.md
@@ -6,8 +6,8 @@ This repo is the Actual Budget community documentation website, built using [Doc
## Welcome
-Firstly, thank you for stopping by and giving up some of your time to either check out the documentation we have already produced or pick off
-some of the [issues](https://github.com/actualbudget/docs/issues) and help create some new documentation for our future users. Check out the
+Firstly, thank you for stopping by and giving up some of your time to either check out the documentation we have already produced or pick off
+some of the [issues](https://github.com/actualbudget/docs/issues) and help create some new documentation for our future users. Check out the
[guidelines](https://actualbudget.org/docs/contributing/writing-docs) for more information on how the documentation is structured and tips for consistent formatting.
### Installation Methods
@@ -28,6 +28,8 @@ However, in doing so, you would become responsible for these instructions. If th
## Contributing 
+Please review the contributing documentation on our website: https://actualbudget.org/docs/contributing/
+
### Issues
If you know of a part of Actual that isn't documented and you would like to know more about that part of the software, open an [Issue](https://github.com/actualbudget/docs/issues) and one of the documentation team will get to it. Or have a go at writing it yourself; we could really use all the help we can get.
@@ -83,4 +85,3 @@ If you are using GitHub pages for hosting, this command is a convenient way to b
### Writing Good Release Notes
For general guidelines, see [Contributing](https://actualbudget.org/docs/contributing/#writing-good-release-notes) section of the documentation. The Documentation site is not versioned in the same manner as the rest of the project. The Documentation website is more of a living document. Merges into `master` will have the title and PR# as commit message, with the PR description as extended git commit description.
-