Guidelines for Submitting Pull Requests - pc2ccs/pc2v9 GitHub Wiki

Submitting a Pull Request (PR) is the method by which a developer notifies the PC2V9 maintainers that a bug fix or new feature has been developed that they would like included into the PC2 code stream. It is typically the last thing done while following the Development Flow.

Before submitting a Pull Request, please make sure you have done the following:

• Read the Guidelines for contributing to PC2.
• Tested your code using the latest development version from the PC2V9 repo (See Development Flow for details on how to verify compatibility with the current PC2V9 develop branch.)
• Created JUnit (or similar) tests to demonstrate that your code works as intended.
• Verified that all existing JUnit tests continue to succeed.
• Provided appropriate documentation for your code.

When creating a Pull Request, please provide the following information in the body of the PR:

• Description

Please enter a complete description of what your Pull Request (code) does -- what it is intended to add to PC^2 and/or what it fixes.

• Test Steps

Please provide a complete list of step-by-step procedures which can be followed to test your PR. (If the PC² maintainers cannot figure out how to properly and fully test your code, your PR is going to be rejected; you should provide detailed steps explaining the process which can be used to verify that your code works as described.)

• Issue

Please enter the existing PC2V9 GitHub Issue number, using a format such as fixes #x, where 'x' is the issue number.

• Environment

Please enter a complete description of the environment in which your code was developed and tested, including

• OS name and version number
• IDE or other development tool(s) which were used in developing your code
• Java version number under which your code was developed and tested
• Target platform(s) on which your code was developed and has been tested.

Failing to include any of the above information could easily result in your PR being rejected.