docs: guidance for contributors

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,37 @@
+---
+name: 🐛 Bug Report
+about: Create a report to help us improve
+title: ''
+labels: bug
+assignees: ''
+---
+
+## First checks
+<!-- Please verify these items before submitting -->
+- [ ] I have checked for related issues
+- [ ] I can reliably reproduce this issue
+
+## Description
+<!-- A clear and concise description of what the bug is and its impact -->
+
+
+## To Reproduce
+<!-- Provide detailed steps to reproduce the issue -->
+1. 
+2. 
+3. 
+
+## Expected Behavior
+<!-- What you expected to happen -->
+
+## Actual Behavior
+<!-- What actually happened. Please include any error messages, logs or screenshots -->
+
+## Environment
+<!-- Please complete all applicable fields -->
+- OS & Version: [e.g. Ubuntu 22.04]
+- Architecture: [e.g. x86_64, arm64]
+- Docker Version: [e.g. 28.0.2]
+- Spectre Version: [e.g. 0.0.9]
+
+

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,10 @@
+---
+name: ✨ Feature Request
+about: Suggest an idea for this project
+title: ''
+labels: enhancement
+assignees: ''
+---
+
+## Description
+<!-- Provide a clear and concise description of the new feature you'd like -->

.github/pull_request_template.md

@@ -15,6 +15,7 @@
 - [ ] I have checked static type hinting with `mypy`
 - [ ] I have added/updated necessary documentation, if required
 - [ ] I have checked for and resolved any merge conflicts
+- [ ] I have performed a self-review of my code
 
 ## Additional notes
 <!-- Any additional information that reviewers should know -->

README.md

@@ -170,7 +170,24 @@ You can also run the CLI locally, without the `spectre-cli` container.
    spectre --help
    ```
 
-## **Quick Start for Developers**
+## Contributing
+A great place to start is creating an issue in our [issue tracker](https://github.com/jcfitzpatrick12/spectre/issues).
+
+### **Making Changes**
+We follow [GitHub flow](https://docs.github.com/en/get-started/using-github/github-flow):
+
+1. Fork this repository, and create a new branch
+2. Make your changes
+3. Write or update tests (all new changes must be covered by unit tests)
+4. Run tests locally to ensure they pass
+5. Commit your changes following [conventional commits](https://www.conventionalcommits.org/)
+6. Push to your fork
+7. Open a Pull Request
+
+**⚠️ Note:**  
+You'll probably notice testing is a little sparse. To the chagrin of Michael Feathers, author of _Working Effectively with Legacy Code_, no unit tests were produced during development. Moving forward any changes _must_ be covered by unit tests.
+
+### **Quick Start for Developers**
 
 _Spectre_ development spans a few repositories:  
 
@@ -180,7 +197,7 @@ _Spectre_ development spans a few repositories:
 | [spectre-core](https://github.com/jcfitzpatrick12/spectre-core)           | Python package containing server-side implementations |
 | [gr-spectre](https://github.com/jcfitzpatrick12/gr-spectre)               | Custom GNU Radio blocks                     |
 
-To begin development, use the development Compose file:
+After you've forked the repository, you can use the development Compose file:
 
 ```bash
 docker compose --file docker-compose.dev.yml up --build
@@ -193,7 +210,4 @@ With the containers running, development is done using [Dev Containers](https://
 If you're working with SDRplay receivers, you will have to start the SDRplay API manually with:  
 ```bash
 sdrplay_apiService & 
-```
-
-## Contributing
-This repository is in active development. If you are interested, feel free to contact  jcfitzpatrick12@gmail.com :)
+```