Skip to content

Aib improve contributing guidance#203

Merged
amaiaita merged 5 commits intomainfrom
aib-improve-contributing-guidance
Apr 1, 2025
Merged

Aib improve contributing guidance#203
amaiaita merged 5 commits intomainfrom
aib-improve-contributing-guidance

Conversation

@amaiaita
Copy link
Copy Markdown
Collaborator

@amaiaita amaiaita commented Mar 28, 2025

Description

What: improving documentation on contributing to the DS website

🧠Why?: currently it requires me to go through it with new people contributing.

👨‍💻How?:

Checklist:

Have checked for the following:

  • The website still builds correctly, and you can view it using mkdocs serve.
  • There are no new "warnings" from mkdocs
  • Does your page follow the page template (or here in Markdown)? (need to make a new one specific to NHSE Data Science)
  • Spelling errors
  • Consistent capitalization
  • Consistent numbers
  • Material features incorrectly implemented: search for code blocks and markers (e.g. !!!).
  • Code snippets don't work
  • Images not working
  • Links not working

Where it was tested

  • Github Codespaces - 2-core, 4GB RAM, 32GB hard drive
  • devcontainer.json describes further settings

Comment thread CONTRIBUTE.md Outdated
Comment thread CONTRIBUTE.md Outdated
Comment thread CONTRIBUTE.md Outdated
Comment thread CONTRIBUTE.md Outdated
Comment thread CONTRIBUTE.md Outdated
@amaiaita amaiaita requested a review from warren-davies4 April 1, 2025 13:00
Copy link
Copy Markdown
Contributor

@warren-davies4 warren-davies4 left a comment

Choose a reason for hiding this comment

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

may_the_merge_be_with_you

@amaiaita
Copy link
Copy Markdown
Collaborator Author

amaiaita commented Apr 1, 2025

@all-contributors add @warren-davies4 for review

@allcontributors
Copy link
Copy Markdown
Contributor

@amaiaita

@warren-davies4 already contributed before to review

@amaiaita
Copy link
Copy Markdown
Collaborator Author

amaiaita commented Apr 1, 2025

@all-contributors add @amaiaita for doc

@allcontributors
Copy link
Copy Markdown
Contributor

@amaiaita

I've put up a pull request to add @amaiaita! 🎉

@amaiaita amaiaita merged commit c671655 into main Apr 1, 2025
@amaiaita amaiaita deleted the aib-improve-contributing-guidance branch April 1, 2025 13:21
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.

2 participants