Hello, and thanks for contributing to PplMyApi
There are two main goals in this document, depending on the nature of your PR:
- description: please tell us about your pr
- checklist: please review the checklist that is most closly related to your PR
The following sections provide more detail on each.
Improve this document
Please don't hesitate to ask questions for clarification, or to make suggestions (or a pull request) to improve this document.
To help the project's maintainers and community to quickly understand the nature of your pull requeset, please create a description that incorporates the following elements:
- what is accomplished by the PR
- if there is something potentially controversial in your PR, please take a moment to tell us about your choices
Please use the checklist that is most closely related to your PR (you only need to use one checklist, and you can skip items that aren't applicable or don't make sense):
- Please review the readme advice section before submitting changes
- Please review the readme advice section before submitting changes
- All existing unit tests are still passing (if applicable)
- Add new passing unit tests to cover the code introduced by your PR
- Update the readme (see readme advice)
- Update or add any necessary API documentation
- If this is a big feature with breaking changes, consider opening an issue to discuss first. This is completely up to you, but please keep in mind that your pr might not be accepted.
- Run unit tests to ensure all existing tests are still passing
- Add new passing unit tests to cover the code introduced by your PR
- Update the readme (see readme advice)
Thanks for contributing!
Please review this section if you are updating readme documentation.
Code comments
Please add code comments (following the same style as existing comments) to describe any code changes or new code introduced by your pull request.