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

Review process for new contributions #289

Merged
merged 6 commits into from
Jul 3, 2024

Conversation

ccarouge
Copy link
Member

@ccarouge ccarouge commented May 10, 2024

CABLE

Thank you for submitting a pull request to the CABLE Project.

Description

Guidelines for the review of new contributions.

Fixes #186

Type of change

Please delete options that are not relevant.

  • New or updated documentation

Checklist

  • The new content is accessible and located in the appropriate section.
  • I have checked that links are valid and point to the intended content.
  • I have checked my code/text and corrected any misspellings

Please add a reviewer when ready for review.


📚 Documentation preview 📚: https://cable--289.org.readthedocs.build/en/289/

@ccarouge ccarouge linked an issue May 10, 2024 that may be closed by this pull request
@ccarouge ccarouge force-pushed the 186-contribution-guidelines-review branch from 63742c5 to 3ab8f45 Compare May 10, 2024 05:35
@ccarouge ccarouge marked this pull request as ready for review May 10, 2024 06:43
@ccarouge ccarouge force-pushed the 186-contribution-guidelines-review branch from b887058 to 5d7b808 Compare May 10, 2024 07:12
@ccarouge ccarouge marked this pull request as draft May 10, 2024 07:13
@ccarouge ccarouge added the priority:low Low priority Issues that do not need to be addressed in the near future. label May 14, 2024
@ccarouge ccarouge requested a review from bschroeter May 15, 2024 23:33
@ccarouge ccarouge marked this pull request as ready for review May 15, 2024 23:33
@ccarouge
Copy link
Member Author

@bschroeter When writing this, I realised having a quick explanation of the PR interface in the CABLE documentation would be good. But I think it needs to come earlier in the contribution guidelines so I'm not including it with this work.

The pages modified by this PR can be found here and here in the rendered documentation.

Copy link
Contributor

@bschroeter bschroeter left a comment

Choose a reason for hiding this comment

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

Looks good - Just that one line by the looks of it.

@ccarouge ccarouge requested a review from bschroeter May 16, 2024 06:09
@bschroeter
Copy link
Contributor

Looks good, might want to check that markdown link check thing.

@ccarouge
Copy link
Member Author

ccarouge commented Jul 3, 2024

The markdown checker is failing on files that have been removed from main but still exist in the outdated documentation in the PR branch. These will be removed from the documentation once merged with main.

@ccarouge ccarouge merged commit 86b086e into main Jul 3, 2024
2 of 3 checks passed
@ccarouge ccarouge deleted the 186-contribution-guidelines-review branch July 3, 2024 06:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
priority:low Low priority Issues that do not need to be addressed in the near future.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Contribution guidelines: review
2 participants