view release on metacpan or  search on metacpan

CONTRIBUTING.md  view on Meta::CPAN

# Contribution Guide

The Ensembl development team welcomes outside contributions, in fact we moved to Git to facilitate this. However, to ensure legibility for other users, we ask contributors to take a few moments to clean up their code, its comments, and its history be...

This guide covers how to contribute changes to an Ensembl project. Please do not create a pull request without reading this guide first.
We also invite you to read our code of conduct (http://www.ensembl.org/info/about/code_of_conduct.html) before continuing.

## Quick Guide - Using Forks & Pull Requests

1. Fork the ensembl repository
2. Switch to the branch you want to edit
  * Consider using feature branches over editing main
3. Hack away and commit with a useful commit message
  * First line is short but descriptive
  * Other lines are more explanatory
4. Make sure your forked main is up-to date with origin and rebase if needed
6. Push
7. Create a pull request
8. Communicate what the change is
9. Wait and celebrate as your change goes in

## Quick Guide - Using Patches

**Whilst patch submission is supported we really prefer users to submit pull requests. Patches also take longer to integrate**

1. Clone the repository
2. Switch to the branch you want to edit
3. Hack away and commit
4. Use `git format-patch` to create the patches
5. Send them to helpdesk for the attention of the team

# Why Could My Pull Request Be Rejected?

We attempt to integrate as many pull requests into Ensembl as possible but do reserve some rights to reject pull requests

* The pull request brought in a non-useful change
    - Single line comments which serve no help to the code
* The pull request removes essential code
* The pull request's history was too complex
    - We want to see as close to a linear set of commits resulting in your final change
    - We will ask for multiple internal merges to be squished into a sensible set of commits
* Poor commit messages
    - Do not repeat the same message in multiple commits
* Excessive whitespace changes
    - Do not reformat someone else's code; it's just bad manners
* The pull request modifies code without testing for regression
    - Please provide simple unit tests to test the changes
* The pull request fails unit testing
    - Please ensure the test suite runs successfully and update the test data if necessary


# License

Ensembl code is licensed under our Apache 2.0 license. Our expectation is that contributing code is made available under the same license. Any copyright assertion to other organistions should be declared in the modyfying file and in the root LICENSE ...

# Using Forks and Pull Requests

This is our preferred method of accepting code contributions. It is the cleanest way and allows us to review your changes quickly before integration.

## Fork and Clone The Repository

You must fork the repository before contributing changes. The big _Fork_ button at the top right of GitHub's interface will automate the process. There is more information from GitHub at https://help.github.com/articles/fork-a-repo.