Skip to content

Conversation

@jpjarnoux
Copy link
Member

@jpjarnoux jpjarnoux commented Oct 16, 2025

Description

This PR adds a pull request template and a saved reply template for code reviews to improve contribution workflow and maintain code quality standards across the project.

Type of change

  • New feature or analysis

Related issue

N/A - Process improvement

What changed

  • Added .github/pull_request_template.md with a flexible structure for contributors
  • Created a saved reply template for reviewers to ensure consistent code review process
  • Template includes sections relevant to bioinformatics projects (datasets, scientific accuracy, reproducibility)

Testing

N/A - Process improvement

Documentation

  • Updated README or docs if needed

Instructions for using the saved reply template are included in the PR description.

Checklist

  • My code follows the project style
  • I've reviewed my own code
  • Complex logic is commented
  • No unnecessary files or debug code included

Additional notes

  • Template will be visible on the next PR opened after this one is merged in main.

For contributors: The PR template includes a disclaimer making it clear that it's a guide, not a strict requirement. This should encourage contributions without creating barriers.

For reviewers: To use the saved reply template:

  1. Go to your GitHub Settings → Saved replies
  2. Click "Add a saved reply"
  3. Name it (e.g., "PR Review Checklist")
  4. Copy the template from the PR description
  5. Use it during reviews by clicking the saved replies icon in the comment box

@jpjarnoux
Copy link
Member Author

jpjarnoux commented Oct 16, 2025

Check of the Reviewer template

✅ Checks

  • Code runs correctly
  • Logic makes sense
  • No obvious bugs
  • Comments help understand the code
  • Update the version number

@jpjarnoux jpjarnoux requested a review from JeanMainguy October 16, 2025 14:49
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