Merge pull request #5381 from beyondessential/release-2024-05

Release 2024-05

.github/CONTRIBUTING.md

@@ -8,21 +8,21 @@ cohesive, maintainable, and globally valuable product.
 ## Code of conduct
 
 This project and everyone participating in it is governed by the
-[BES Open Source Code of Conduct](code-of-conduct.md).
-By participating, you are expected to uphold this code. Please report unacceptable behaviour to [opensource@bes.au](opensource@bes.au).
+[BES Open Source Code of Conduct](CODE_OF_CONDUCT.md).
+By participating, you are expected to uphold this code. Please report unacceptable behaviour to [opensource@bes.au](mailto:opensource@bes.au).
 
-## Copyright Attribution
+## Copyright attribution
 
 All open-source contributors to Tupaia will be required to sign a Contributor License Agreement (CLA)
 before BES can accept your contribution into the project code. This is done so that we can continue
 to maintain the codebase covered by a single license. Signing a CLA can be done through GitHub
 before merging in your first pull request.
 
-## Our Philosophy
+## Our philosophy
 
 Our core philosophy is to maintain the long-term sustainability of Tupaia. We, at BES work hard
 to maintain a cohesive vision for the project. While we encourage collaboration and contributions,
-we also want to avoid fragmentation that could compromise Tupaia's usability, maintainability,
+we also want to avoid fragmentation that could compromise Tupaia’s usability, maintainability,
 and value. We believe that the best way to contribute is to align your efforts with our existing
 product roadmap.
 
@@ -31,70 +31,70 @@ product roadmap.
 Before considering becoming an open-source contributor for Tupaia, please take note that becoming
 an open-source contributor requires a significant amount of time onboarding, and ongoing
 coordination and support from BES as the project maintainers. As such we encourage contributions
-from individuals and organizations who are prepared to invest significant amounts of time into
+from individuals and organisations who are prepared to invest significant amounts of time into
 their work, ensuring alignment with our roadmap and the highest quality results. While we appreciate
 the interest of potential casual contributors, we aim to collaborate with contributors who are
-serious about their commitment to Tupaia. If you're ready to deeply engage and uphold Tupaia's
+serious about their commitment to Tupaia. If you’re ready to deeply engage and uphold Tupaia’s
 vision and standards, we warmly welcome your involvement.
 
-### Following Our Roadmap
+### Following our roadmap
 
 Before making your contribution, make sure that it aligns with our product roadmap for Tupaia.
 This ensures that your contribution builds towards a cohesive vision for Tupaia. This generally
 means pulling in features from our existing roadmap, and speeding up the delivery process into the
 core product. We will gladly co-design features if you identify something missing from the roadmap
 that will benefit the users of Tupaia.
 
-#### Meaningful Contributions (under construction)
+#### Meaningful contributions (under construction)
 
 To assess whether or not your contribution will be meaningful to the development of Tupaia before
 making your contribution, put your contribution idea against the following criteria:
 
 **Documentation:**
 
-- If there is no documentation for a specific aspect of Tupaia
-- If a specific area in the project's documentation is either: lacking detail, outdated or unclear.
+- If there is no documentation for a specific aspect of Tupaia.
+- If a specific area in the project’s documentation is either: lacking detail, outdated or unclear.
 
 **Features:**
 
-- If the feature aligns with the Tupaia roadmap
-- If your feature has been co-designed with a BES developer
+- If the feature aligns with the Tupaia roadmap.
+- If your feature has been co-designed with a BES developer.
 
-### Developer Onboarding and Orientation
+### Developer onboarding and orientation
 
 Being a complex product, Tupaia is at the stage where supported onboarding is necessary for the
-project's contributors. The BES Tupaia team are happy to provide hands-on support for serious and
-committed contributors, But we will ask to see evidence of your commitment as well as a CV.
+project’s contributors. The BES Tupaia team are happy to provide hands-on support for serious and
+committed contributors, but we will ask to see evidence of your commitment as well as a CV.
 
-Steps for onboarding and setting up your development environment can be found on our [README](../README.md).
-However, it's most likely that support is needed from a BES developer in order for a successful and
+Steps for onboarding and setting up your development environment can be found on our [README](/#readme).
+However, it’s most likely that support is needed from a BES developer in order for a successful and
 stable onboarding.
 
 ## Making your code contribution
 
-You can find an outline of the project structure and prerequisites on our [Readme](https://github.com/beyondessential/tupaia/blob/master/README.md)
+You can find an outline of the project structure and prerequisites on our [README](/#readme).
 
-### Code Quality
+### Code quality
 
 When making your contribution, please ensure that your code is of high quality. Follows best
 practices, write clean and readable code, add comments where necessary, and thoroughly test your
 code. We have a code review process for all contributions, and have a high bar for quality.
 
-### Branch Naming Conventions
+### Branch naming conventions
 
 For open-source contribution branches, the naming convention is:
 
     <issue-id>-<description>
 
-For example, `1736-pdf-export-crash`
+For example, `1736-pdf-export-crash`.
 
-### Branching Strategy
+### Branching strategy
 
 1. When creating a branch for your contribution, branch off the latest `dev`.
 2. Make your commits on the branch you made.
-3. Once your changes are complete, pull from the latest `dev` and create a pull request on GitHub
+3. Once your changes are complete, pull from the latest `dev` and create a pull request on GitHub.
 
-### Pull Requests
+### Pull requests
 
 When your contribution is ready for review, create a pull request. A BES developer will review
 your changes and provide feedback. If your pull request has been approved by a reviewer, it
@@ -110,7 +110,7 @@ encourage you to collaborate with us on the mainline product roadmap.
 
 ## Licence
 
-Any contributions you make will be licensed under [our open-source license](https://github.com/beyondessential/tupaia/blob/master/LICENSE)
+Any contributions you make will be licensed under [our open-source licence](/LICENSE)
 
 ---
 

.gitignore

@@ -13,8 +13,6 @@
 *.aes
 *.code-workspace
 *.pem
-codeship_deploy_key.pub
-codeship_deploy_key
 dump.sql
 *.todo
 **/cypress/screenshots