Merge branch 'tristan/contributing-guide' into 'master'

Update contributing guide

See merge request BuildStream/buildstream!801

6 files changed, 10 insertions, 4 deletions

diff --git a/HACKING.rst b/CONTRIBUTING.rst
index 1c5832597..ee956db2a 100644
--- a/HACKING.rst
+++ b/CONTRIBUTING.rst
@@ -10,6 +10,12 @@ Major feature additions should be proposed on the
 before being considered for inclusion, we strongly recommend proposing
 in advance of commencing work.
 
+If you are experiencing an issue with BuildStream or would like to submit a small patch/feature, then
+you can open issue `here <https://gitlab.com/BuildStream/buildstream/issues/new?issue%5Bassignee_id%5D=&issue%5Bmilestone_id%5D=>`
+
+For policies on how to submit and issue and how to use our project labels, we recommend that you read the policies guide
+`here <https://gitlab.com/BuildStream/nosoftware/alignment/blob/master/BuildStream_policies.md>`
+
 New features must be well documented and tested either in our main
 test suite if possible, or otherwise in the integration tests.
 
diff --git a/MANIFEST.in b/MANIFEST.in
index f9e506027..9c16ce051 100644
--- a/MANIFEST.in
+++ b/MANIFEST.in
@@ -1,7 +1,7 @@
 # Basic toplevel package includes
 include BuildStream.doap
 include COPYING
-include HACKING.rst
+include CONTRIBUTING.rst
 include MAINTAINERS
 include NEWS
 include README.rst
diff --git a/doc/bst2html.py b/doc/bst2html.py
index eaf25eae8..e453874fc 100755
--- a/doc/bst2html.py
+++ b/doc/bst2html.py
@@ -444,7 +444,7 @@ def run_session(description, tempdir, source_cache, palette, config_file, force)
 def run_bst(directory, force, source_cache, description, palette):
     """Run a bst command and capture stdout/stderr in html
 
-    This command normally takes a description yaml file, see the HACKING
+    This command normally takes a description yaml file, see the CONTRIBUTING
     file for information on it's format.
     """
     if not source_cache and os.environ.get('BST_SOURCE_CACHE'):
diff --git a/doc/source/CONTRIBUTING.rst b/doc/source/CONTRIBUTING.rst
new file mode 120000
index 000000000..e9a8ba642
--- /dev/null
+++ b/doc/source/CONTRIBUTING.rst
@@ -0,0 +1 @@
+../../CONTRIBUTING.rst
\ No newline at end of file
diff --git a/doc/source/HACKING.rst b/doc/source/HACKING.rst
deleted file mode 120000
index a2f06b723..000000000
--- a/doc/source/HACKING.rst
+++ /dev/null
@@ -1 +0,0 @@
-../../HACKING.rst
\ No newline at end of file
diff --git a/doc/source/index.rst b/doc/source/index.rst
index ac4587f10..bc6ecbed2 100644
--- a/doc/source/index.rst
+++ b/doc/source/index.rst
@@ -21,7 +21,7 @@ Later sections provide detailed information on BuildStream internals.
    main_install
    main_using
    main_core
-   HACKING
+   CONTRIBUTING
 
 
 Resources