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

2446 update developer guideline docs #2453

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

JackEAllen
Copy link
Collaborator

@JackEAllen JackEAllen commented Jan 10, 2025

Issue

Closes #2446

Description

Add to developer conventions documentation to describe Mantid Imagings version control processes to help new developers get up to speed.

Add a "Contributing" sub-header to the projects README.md to link to developer conventions and developer guide recourses.

Testing

Describe the tests that were used to verify your changes.

  • Proof read
  • Validated that Sphinx documentation builds correctly
    • build docs: make build-docs
    • run python server: python -m http.server
    • Open a browser and navigate the build docs to view them.

Acceptance Criteria

How should the reviewer test your changes?

  • Content is grammatically correct.
  • content clearly describes best practices for version control in Mantid Imaging, assuming no prior experience with version control or the Mantid Imaging project.
  • Sphinx documentation builds correctly
    • Build docs: make build-docs
    • run python server: python -m http.server
    • Open a browser and navigate the built docs to view them:
    file:///<full>/<path>/<to>/mantidimaging/docs/build/html/developer_guide/explanations/developer_conventions.html
  • README.md improves accessibility to contributing to the Mantid Imaging Project.

Documentation

N/A this PR does not require release notes.

Update the developer conventions to include version control processes with Git and GitHub
Add a contributers subheader to the README.md to direct anyone wishing to contribute to any relevant resources to get started
@JackEAllen JackEAllen force-pushed the 2446-update_developer_guideline_docs branch from 8b53a75 to 878932f Compare January 10, 2025 12:02
@JackEAllen JackEAllen marked this pull request as ready for review January 10, 2025 13:30
@coveralls
Copy link

Coverage Status

coverage: 73.622%. remained the same
when pulling 878932f on 2446-update_developer_guideline_docs
into 3f099d2 on main.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update Developer Guidelines Documentation
2 participants