Skip to content

Conversation

@harryswift01
Copy link
Contributor

Summary

This PR reviews and updates the community documentation to ensure accuracy and relevance. It replaces outdated contact information (including personal email addresses) with the new official CCPBioSim contact email, and ensures other metadata and workflow references remain current.


Changes

Change 1: Update contact information in community documents

  • Updated the Code of Conduct to replace the outdated Gmail contact with the new official CCPBioSim email address.
  • Ensured consistency of contact details across other community-facing documents (e.g., CONTRIBUTING.md, CITATION.cff if applicable).

Change 2: Update project metadata and release information

  • Added ORCID information within the CITATION.cff file.
  • Updated version and date-released fields within CITATION.cff.

Change 3: Documentation and workflow maintenance

  • Improved project description text within __init__.py for clarity.
  • Added CITATION.cff version update step to the release workflow for automated maintenance.
  • Confirmed formatting and syntax compliance for all updated YAML and CFF files.

Impact

  • Improves accuracy and professionalism of community documentation.
  • Ensures contributors and users contact the correct maintainers via the new official CCPBioSim email address.
  • Keeps citation metadata and release automation up to date.

- Update `.github/workflows/release.yaml` to bump `CITATION.cff` version and date-released automatically
- Keep version in `__init__.py` and `CITATION.cff` in sync during releases
- Fully automated in CI, no manaul edits needed
@harryswift01 harryswift01 added this to the v1.0.4 milestone Nov 5, 2025
@harryswift01 harryswift01 requested a review from jimboid November 5, 2025 10:10
@harryswift01 harryswift01 self-assigned this Nov 5, 2025
@harryswift01 harryswift01 added the documentation Improvements or additions to documentation label Nov 5, 2025
@harryswift01 harryswift01 linked an issue Nov 5, 2025 that may be closed by this pull request
Copy link
Member

@jimboid jimboid left a comment

Choose a reason for hiding this comment

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

Looks great Harry. My only comment is to save your sanity, you could link to the developer documentation for the steps to fork (assuming you pasted this from there?) so you don't have to remember to maintain both. Happy for you to decide this, please go ahead and merge when ready.

@harryswift01
Copy link
Contributor Author

Looks great Harry. My only comment is to save your sanity, you could link to the developer documentation for the steps to fork (assuming you pasted this from there?) so you don't have to remember to maintain both. Happy for you to decide this, please go ahead and merge when ready.

That's a very good point, thank you. I've simplified the CONTRIBUTING.md so we can avoid duplication.

@harryswift01 harryswift01 merged commit 71a7253 into main Nov 5, 2025
13 checks passed
@harryswift01 harryswift01 deleted the 158-review-community-docs branch November 5, 2025 12:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

review community docs

3 participants