From 8771403c9054d73dfafcf5c64a80f65f982e575a Mon Sep 17 00:00:00 2001
From: Giselle Rosetta <135234996+gisellerosetta@users.noreply.github.com>
Date: Wed, 13 Dec 2023 15:12:25 +0000
Subject: [PATCH] add contribution guidance (#46)

* add contribution guidance

* update contribution guidance, add git issue template
---
 CONTRIBUTING.md   | 25 +++++++++++++++++++++++++
 ISSUE_TEMPLATE.md | 13 +++++++++++++
 2 files changed, 38 insertions(+)
 create mode 100644 CONTRIBUTING.md
 create mode 100644 ISSUE_TEMPLATE.md

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 0000000..845b9b3
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,25 @@
+# Contributing
+When contributing to this repository, please first discuss the change you wish
+to make, added functionality you'd like to see, or bug you've found via one
+of the following:
+- Raising a github issue using the issue template;
+- Emailing ASAP@ons.gov.uk;
+- Contacting the py-af-colours team on the data-vis govdatascience channel;
+- Using the Accessibility and Presentation/Dissemination of Statistics Basecamp groups.
+
+## Pull/merge request process
+1. Branch from the `main` branch. If you are implementing a feature name it
+`feature/name_of_feature`, if you are implementing a bugfix name it
+`bug/issue_name`.
+2. Update the README.md and other documentation with details of major changes
+to the interface, this includes new environment variables, useful file
+locations and container parameters. If you have added new functionality,
+please include an example.
+3. Once you are ready for review please open a pull/merge request to the
+`main` branch.
+4. You may merge the Pull/Merge Request in once you have the sign-off of an owner.
+
+## Code style
+- We follow the [PEP8](https://peps.python.org/pep-0008/) style.
+- We use the [numpydoc](https://numpydoc.readthedocs.io/en/latest/format.html)
+format for documenting features using docstrings.
\ No newline at end of file
diff --git a/ISSUE_TEMPLATE.md b/ISSUE_TEMPLATE.md
new file mode 100644
index 0000000..afda1fc
--- /dev/null
+++ b/ISSUE_TEMPLATE.md
@@ -0,0 +1,13 @@
+# Issue Template
+title: <Short title>
+author: <Full name>
+
+# Issue
+<Brief explanation of problem>
+
+# Proposed Change
+<If proposing new functionality; any ideas, suggestions, options, including links to guidance if relevant>
+
+# Type of Change Requested
+[ ] Bug fix
+[ ] New feature
\ No newline at end of file