Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updates to contributing.md and readme #640

Merged
merged 8 commits into from
Oct 20, 2023
Merged

Conversation

keegansmith21
Copy link
Contributor

@keegansmith21 keegansmith21 commented Sep 14, 2023

Changes to some existing docs. These need updating as they're out of date with the current state of the repo. I also make reference the the platform's dependent repositories as they use the same systems.

Notes for post-merge:

  • Rename develop branch to main
  • Update the two dependent repositories with a contributing guide that references this one

@keegansmith21
Copy link
Contributor Author

@jdddog Please have a look over the changes and current state of the changed docs. It would be good to get your input - please make any changes you think necessary

@codecov
Copy link

codecov bot commented Sep 14, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (379ed90) 87.05% compared to head (843dfd0) 87.05%.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #640   +/-   ##
=======================================
  Coverage   87.05%   87.05%           
=======================================
  Files          34       34           
  Lines        4713     4713           
  Branches      574      574           
=======================================
  Hits         4103     4103           
  Misses        483      483           
  Partials      127      127           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@keegansmith21 keegansmith21 marked this pull request as ready for review October 17, 2023 02:16
kathrynnapier
kathrynnapier previously approved these changes Oct 20, 2023
Copy link
Contributor

@kathrynnapier kathrynnapier left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @keegansmith21 - changes look good to me, I like the additions of the dependent repos. I've also added in a code of conduct file as well, that I'd like @jdddog to take a quick look at

@jdddog jdddog force-pushed the contributing_guide_update branch from 404a6db to 843dfd0 Compare October 20, 2023 03:44
Copy link
Contributor

@jdddog jdddog left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks Keegan and Kathryn, the changes look good to me.

CONTRIBUTING.md Outdated Show resolved Hide resolved
@jdddog jdddog enabled auto-merge October 20, 2023 04:05
@jdddog jdddog added this pull request to the merge queue Oct 20, 2023
Merged via the queue into main with commit 12cb321 Oct 20, 2023
jdddog added a commit that referenced this pull request Feb 25, 2024
Co-authored-by: kathrynnapier <kathryn.napier@curtin.edu.au>
Co-authored-by: Jamie Diprose <5715104+jdddog@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants