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

docs(template): PR template attribution to comment #363

Merged
merged 1 commit into from
Jan 9, 2024

Conversation

d33bs
Copy link
Member

@d33bs d33bs commented Jan 9, 2024

Description

This PR makes a quick adjustment to the PR template to avoid a step which is performed each time a PR is opened on GitHub to remove the template credit text. Moving to an HTML comment for this text retains the credit in the PR text without rendering it when reading the PR text, removing a step for maintainers to remove the content each time a PR is opened (and persisting the credit).

Thank you for any feedback you may have!

Related to and ported from: cytomining/CytoTable#139 (review)

What is the nature of your change?

  • Bug fix (fixes an issue).
  • Enhancement (adds functionality).
  • Breaking change (fix or feature that would cause existing functionality to not work as expected).
  • This change requires a documentation update.

Checklist

Please ensure that all boxes are checked before indicating that a pull request is ready for review.

  • I have read the CONTRIBUTING.md guidelines.
  • My code follows the style guidelines of this project.
  • I have performed a self-review of my own code.
  • I have commented my code, particularly in hard-to-understand areas.
  • I have made corresponding changes to the documentation.
  • My changes generate no new warnings.
  • New and existing unit tests pass locally with my changes.
  • I have added tests that prove my fix is effective or that my feature works.
  • I have deleted all non-relevant text in this pull request template.

@d33bs d33bs requested review from gwaybio and kenibrewer January 9, 2024 13:17
@d33bs
Copy link
Member Author

d33bs commented Jan 9, 2024

Thank you @gwaybio and @kenibrewer ! May I merge this in?

@gwaybio
Copy link
Member

gwaybio commented Jan 9, 2024

Yep, you are a maintainer and this PR has at least one approval by a maintainer 👍

@d33bs d33bs merged commit cf313bf into cytomining:main Jan 9, 2024
9 checks passed
@d33bs d33bs deleted the update-pr-template-attribution branch January 9, 2024 18:28
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.

3 participants