generated from bokulich-lab/q2-plugin-template
-
Notifications
You must be signed in to change notification settings - Fork 14
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'main' into feature_data_prodigal_iss_101
- Loading branch information
Showing
4 changed files
with
44 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,38 @@ | ||
### What's new | ||
- Describe what was changed in the code and why it is useful or necessary | ||
- Closes #<issue_number> | ||
|
||
```[tasklist] | ||
### Blocked by... | ||
- [ ] merge after user/repo_name#PR_number | ||
- [ ] depends on #PR_number | ||
``` | ||
|
||
### Run it locally | ||
1. Checkout the PR branch. | ||
|
||
> Assuming 1) you already have a local copy of `q2-moshpit` that is installed in editable mode in your activated virtual environment and 2) the working directory is `q2-moshpit`; run the following. | ||
```bash | ||
PR=<PR_number> | ||
git fetch origin pull/${PR}/head:pr-${PR} | ||
git checkout pr-${PR} | ||
``` | ||
|
||
2. Let's get you some data to play with: | ||
```bash | ||
<your code here> | ||
``` | ||
|
||
3. Test it out! | ||
```bash | ||
<your code here> | ||
``` | ||
|
||
### TODO | ||
- [ ] Fill in *Whats new* section. Erase any bullet points that are not used. | ||
- [ ] Erase *Blocked by...* task list if not used. | ||
- [ ] In *Run it locally*, **step 1**, make sure to write the PR number after you have submitted the PR. | ||
- [ ] In *Run it locally*, **step 2**, fill in the code to fetch the inputs to test the code. | ||
- [ ] In *Run it locally*, **step 3**, fill in the code to test the changes. | ||
- [ ] Erase the *TODO* section. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters