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

Editing instructions for contributing to the documentation #1833

Merged
merged 4 commits into from
Dec 7, 2021

Conversation

isaacgsmith
Copy link
Member

@isaacgsmith isaacgsmith commented Nov 28, 2021

Description

This adds to and consolidates the directions for contributing to the TARDIS documentation.

Motivation and context

As the documentation has expanded, the explanation as to how to add to it has needed many updates.

How has this been tested?

  • Testing pipeline.
  • Other.
    Docs built locally.

Examples

https://smithis7.github.io/tardis/branch/instructions_doc/development/documentation_guidelines.html

Type of change

  • Bug fix.
  • New feature.
  • Breaking change.
  • None of the above.

Checklist

  • My change requires a change to the documentation.
    • I have updated the documentation accordingly.
    • (optional) I have built the documentation on my fork following the instructions.
  • I have assigned and requested two reviewers for this pull request.

@isaacgsmith isaacgsmith changed the title Editing instructions for contributing to the documentation. Editing instructions for contributing to the documentation Nov 28, 2021
@tardis-bot
Copy link
Contributor

Before a pull request is accepted, it must meet the following criteria:

  • Is the necessary information provided?
  • Is this a duplicate PR?
    • If a new PR is clearly a duplicate, ask how this PR is different from the original PR?
    • If this PR is about to be merged, close the original PR with a link to this new PR that solved the issue.
  • Does it pass existing tests and are new tests provided if required?
    • The test coverage should not decrease, and for new features should be close to 100%.
  • Is the code tidy?
    • No unnecessary print lines or code comments.

@codecov
Copy link

codecov bot commented Nov 28, 2021

Codecov Report

Merging #1833 (4125225) into master (f52044a) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master    #1833   +/-   ##
=======================================
  Coverage   58.04%   58.04%           
=======================================
  Files          66       66           
  Lines        6747     6747           
=======================================
  Hits         3916     3916           
  Misses       2831     2831           

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update f52044a...4125225. Read the comment docs.

Copy link
Member

@jaladh-singhal jaladh-singhal left a comment

Choose a reason for hiding this comment

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

This looks excellent! Thanks for updating it.

docs/development/documentation_guidelines.rst Outdated Show resolved Hide resolved
@jaladh-singhal jaladh-singhal merged commit 8716466 into tardis-sn:master Dec 7, 2021
@isaacgsmith isaacgsmith deleted the instructions_doc branch December 20, 2021 15:29
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.

5 participants