Skip to content

Latest commit

 

History

History
42 lines (25 loc) · 1.74 KB

PULL_REQUEST_TEMPLATE.md

File metadata and controls

42 lines (25 loc) · 1.74 KB

Requirements

  • Filling out the template is required. Any pull request that does not include enough information to be reviewed in a timely manner may be closed at the maintainers' discretion;
  • Review the contributing guidelines for this repository; remember in particular:
    • do not modify code without testing for regression
    • provide simple unit tests to test the changes
    • the PR must not fail unit testing
    • if you're adding/updating documentation of an endpoint, make sure you add/update the necessary parameters to the (template) configuration files in the ensembl-rest_private repo

Description

Using one or more sentences, describe in detail the proposed changes.

Use case

Describe the problem. Please provide an example representing the motivation behind the need for having these changes in place.

Benefits

If applicable, describe the advantages the changes will have.

Possible Drawbacks

If applicable, describe any possible undesirable consequence of the changes.

Testing

note to submitters and reviewers: documentation-only changes may reflect changes in other repos that can result in new or different output from REST endpoints. In turn, these may require new tests or changes to existing tests.

Have you added/modified unit tests to test the changes?

If so, do the tests pass/fail?

Have you run the entire test suite and no regression was detected?

Changelog

Are you changing the functionality of an endpoint? If so, please give a one line summary for the public facing changelog.

eg. [/xenobiology/orthologs] Added the ability to look up orthologs and paralogs from klingons and andorians