Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
51 changes: 51 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
<!-- This template is here to help you structure your PR, but feel free to adapt it to your needs. Not all sections may be relevant for your contribution. -->

## Description

<!-- Briefly describe what this PR does and why -->

## Related issue

<!-- Link to relevant issue if applicable -->
Closes #

## What changed

<!-- List the main changes -->

-
-

## Testing

<!-- Describe how you tested your changes -->

**Test environment:**

- Dataset used:
- Key parameters:

**Results:**

-

## Documentation
<!-- Mark the relevant option with an "x" -->

- [ ] Added/updated code comments
- [ ] Added/updated docstring
- [ ] Updated README or docs if needed
- [ ] Added example usage (if relevant)

## Checklist
<!-- Mark the relevant option with an "x" -->

- [ ] My code follows the project guidelines
- [ ] Complex logic is commented
- [ ] No unnecessary files or debug code included
- [ ] My PR is targeting the `dev` branch

## Additional notes

<!-- Any other context, dependencies, or things reviewers should know -->

2 changes: 1 addition & 1 deletion VERSION
Original file line number Diff line number Diff line change
@@ -1 +1 @@
0.6.0
0.6.1
52 changes: 23 additions & 29 deletions docs/developer/git.md
Original file line number Diff line number Diff line change
Expand Up @@ -97,44 +97,38 @@ You've done the hard work - now let's get it merged!

### PR Title and Description

Write a clear title that summarizes your change and use the PR template to provide context:
Write a clear title that summarizes your change and use the PR template to provide context.

```markdown
## What does this PR do?

Adds a new module for detecting CRISPR-Cas systems in bacterial genomes using HMM profiles.

## Why is this needed?

Many users requested CRISPR detection capabilities. This addresses issue #123.

## What changed?

- Added `panorama/crispr/detector.py` with detection logic
- Added HMM profiles for Cas proteins
- Added unit tests (coverage: 95%)
- Updated user documentation with examples
```{important}
If your PR addresses an issue, link it! Use these keywords in your PR description:
- `Fixes #123` - Automatically closes issue when PR merges
- `Closes #123` - Same as above
- `Related to #123` - Links without closing
```

## How to test?
### For reviewer

pytest tests/test_crispr.py
panorama detect_crispr --pangenome examples/ecoli.h5
Before to validate the commit change, you should check the elements in the following template for reviewer.

## Related Issues
```md
## Quick Review

Closes #123
Related to #456
### ✅ Checks
- [ ] Code runs correctly
- [ ] Logic makes sense
- [ ] No obvious bugs
- [ ] Comments help understand the code

## Version
### 💬 Feedback
<!-- Your comments here -->

Updated VERSION from 1.2.5 → 1.2.6
**Status:** ✅ Approved / 🔄 Suggestions / ❌ Changes needed
```

```{important}
If your PR addresses an issue, link it! Use these keywords in your PR description:
- `Fixes #123` - Automatically closes issue when PR merges
- `Closes #123` - Same as above
- `Related to #123` - Links without closing
```{tip}
You can add this template direclty in your saved replies (Go to your Settings->Saved replies)

See [Using saved replies documentation](https://docs.github.com/en/get-started/writing-on-github/working-with-saved-replies/using-saved-replies)
```

## Keeping Your Branch Updated
Expand Down
Loading