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

Prepare for package registration #12

Merged
merged 17 commits into from
Jul 11, 2022
Merged

Prepare for package registration #12

merged 17 commits into from
Jul 11, 2022

Conversation

MillironX
Copy link
Member

@MillironX MillironX commented Jul 5, 2022

Types of changes

This PR implements the following changes:

  • ✨ New feature (A non-breaking change which adds functionality).
  • πŸ› Bug fix (A non-breaking change, which fixes an issue).
  • πŸ’₯ Breaking change (fix or feature that would cause existing functionality to change).

πŸ“‹ Additional detail

This PR adds metadata and workflow information to prepare SequenceVariation for registration in the general registry. Specific additions:

  • GitHub actions workflows
    • CompatHelper
    • Documenter
    • TagBot
    • CI/Unit testing
    • @JuliaRegistrator
  • GitHub issue/pull request templates
  • Documentation
  • gitignore for Manifest.toml (and removed Manifest.toml)
  • License
  • Changelog
  • [compat] section to Project.toml

Fixes #8

β˜‘οΈ Checklist

  • 🎨 The changes implemented is consistent with the julia style guide.
  • πŸ“˜ I have updated and added relevant docstrings, in a manner consistent with the documentation styleguide.
  • πŸ“˜ I have added or updated relevant user and developer manuals/documentation in docs/src/.
  • πŸ†— There are unit tests that cover the code changes I have made.
  • πŸ†— The unit tests cover my code changes AND they pass.
  • πŸ“ I have added an entry to the [UNRELEASED] section of the manually curated CHANGELOG.md file for this repository.
  • πŸ†— All changes should be compatible with the latest stable version of Julia.
  • πŸ’­ I have commented liberally for any complex pieces of internal code.

@BioJulia BioJulia deleted a comment from JuliaRegistrator Jul 5, 2022
@MillironX
Copy link
Member Author

@jakobnissen I'd appreciate you looking this over to make sure everything is up to BioJulia standards. Thanks

@MillironX MillironX requested a review from kescobo July 5, 2022 16:20
@MillironX MillironX merged commit 976d5b3 into BioJulia:master Jul 11, 2022
@kescobo
Copy link
Member

kescobo commented Jul 11, 2022

πŸŽ‰

@kescobo
Copy link
Member

kescobo commented Jul 11, 2022

Sorry for never getting to review, but it all looks great! Thanks for getting it set up.

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.

Feature request: Include in GeneticVariation or register as standalone package
2 participants