Merge pull request #86 from ONSdigital/development

Release 0.2.0

.bumpversion.cfg

@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 0.1.10
+current_version = 0.2.0
 commit = False
 tag = False
 parse = (?P<major>\d+)\.(?P<minor>\d+)\.(?P<patch>\d+)

CHANGELOG.md

@@ -9,12 +9,30 @@ and this project adheres to [semantic versioning](https://semver.org/spec/v2.0.0
 
 ### Added
 
+### Changed
+
+### Deprecated
+
+### Fixed
+
+### Removed
+
+## [v0.2.0] - 2024-05-10
+
+### Added
+
 ### Changed
 - **Breaking Change**: Renamed module `cdsw` to `cdp` (Cloudera Data Platform).
+- Added a "Further Reading on Reproducible Analytical Pipelines" section to `README.md`
+  to enhance resources on RAP best practices.
+- Added section on synchronising the `development` branch with `main` to 
+  the `branch_and_deploy_guide.md` file.  
 
 ### Deprecated
 
 ### Fixed
+- Updated `contribution_guide.md`; fix code block rendering issue in `mkdocs` by 
+  removing extra whitespaces.
 
 ### Removed
 
@@ -245,6 +263,8 @@ and this project adheres to [semantic versioning](https://semver.org/spec/v2.0.0
 > and GitHub Releases.
 
 
+- rdsa-utils v0.2.0: [GitHub Release](https://github.com/ONSdigital/rdsa-utils/releases/tag/v0.2.0) | 
+  [PyPI](https://pypi.org/project/rdsa-utils/0.2.0/)
 - rdsa-utils v0.1.10: [GitHub Release](https://github.com/ONSdigital/rdsa-utils/releases/tag/v0.1.10) | 
   [PyPI](https://pypi.org/project/rdsa-utils/0.1.10/)
 - rdsa-utils v0.1.9: [GitHub Release](https://github.com/ONSdigital/rdsa-utils/releases/tag/v0.1.9) | 

README.md

@@ -28,6 +28,18 @@ pip install rdsa-utils
 
 Our documentation is automatically generated using **GitHub Actions** and **MkDocs**. For an in-depth understanding of `rdsa-utils`, how to contribute to `rdsa-utils`, and more, please refer to our [MkDocs-generated documentation](https://onsdigital.github.io/rdsa-utils/).
 
+## 📘 Further Reading on Reproducible Analytical Pipelines
+
+While `rdsa-utils` provides essential tools for data processing, it represents just one aspect of the broader development process necessary for building and maintaining robust, high-quality codebases. Adhering to best practices and utilising the right tools are crucial for success.
+
+We highly recommend exploring the following resources to gain deeper insights into the creation of Reproducible Analytical Pipelines (RAP), which delve into key topics such as version control, modular code development, unit testing, and peer review -- all vital for developing these pipelines:
+
+- [Reproducible Analytical Pipelines (RAP) Resource](https://analysisfunction.civilservice.gov.uk/support/reproducible-analytical-pipelines/) - This resource offers an overview of Reproducible Analytical Pipelines, covering benefits, case studies, and guidelines on building a RAP. It discusses minimising manual steps, using open source software like R or Python, enhancing quality assurance through peer review, and ensuring auditability with version control. It also addresses challenges and considerations for implementing RAPs, such as data access restrictions or confidentiality, and underscores the importance of collaborative development.
+
+- [Quality Assurance of Code for Analysis and Research](https://best-practice-and-impact.github.io/qa-of-code-guidance/intro.html) - This book details methods and practices for ensuring high-quality coding in research and analysis, including unit testing and peer reviews.
+
+- [PySpark Introduction and Training Book](https://best-practice-and-impact.github.io/ons-spark/intro.html) - An introduction to using PySpark for large-scale data processing.
+
 ## 🛡️ Licence
 
 Unless stated otherwise, the codebase is released under the [MIT License][mit].

docs/branch_and_deploy_guide.md

@@ -183,6 +183,31 @@ and reliability. Below is a straightforward guide on the procedure:
       which includes building the package, publishing to PyPI, and creating a 
       GitHub Release with the new version tag.
 
+### Synchronizing Development Branch Post-Merge
+
+After the pull request from `development` to `main` has been merged, it is crucial to 
+synchronise the `development` branch with the changes in `main`. Perform the following 
+steps to ensure that `development` stays up-to-date:
+
+- **Pull Changes from Main**:
+    - Execute `git pull origin main` to fetch and merge the latest changes from 
+      the `main` branch into your current branch.
+
+- **Switch to Development Branch**:
+    - Use `git checkout development` to switch from your current branch 
+      to the `development` branch.
+
+- **Merge Main into Development**:
+    - Run `git merge main` while on the `development` branch to merge the 
+      changes from the `main` branch into `development`.
+
+- **Push Updated Development**:
+    - After merging, push the updated `development` branch back to the remote 
+      repository using `git push origin development`.
+
+These commands ensure that the `development` branch reflects the latest 
+state of `main`, maintaining consistency across your project's branches.
+
 By adhering to these steps, you'll make the transition from development to production 
 smooth and efficient, ensuring the codebase remains stable and the release process flows 
 seamlessly. As maintainers, your pivotal role guarantees the `rdsa-utils` package's 

docs/contribution_guide.md

@@ -102,15 +102,15 @@ Pre-commit hooks are used to automate checks and formatting before commits. Foll
 
 1. **Install pre-commit**: If you haven't already, install the pre-commit package:
 
-   ```bash
-   pip install pre-commit
-   ```
+```bash
+pip install pre-commit
+```
 
 2. **Install pre-commit hooks**: Install the hooks defined in `.pre-commit-config.yaml`:
 
-   ```bash
-   pre-commit install
-   ```
+```bash
+pre-commit install
+```
 
    This sets up the hooks to run automatically before each commit.
 

rdsa_utils/__init__.py

@@ -1 +1 @@
-__version__ = '0.1.10'
+__version__ = '0.2.0'