Skip to content

Latest commit

 

History

History
26 lines (18 loc) · 2.17 KB

pull_request_template.md

File metadata and controls

26 lines (18 loc) · 2.17 KB

Please read, especially if your first time contributing to PhantomBot:

Thank you for contributing to PhantomBot! Hopefully you followed the code style guide: https://github.com/PhantomBot/PhantomBot/blob/master/CODESTYLE.md

If you added in code from a third party, it must have a license that is compatible with PhantomBot. If it is not, we will reject the merge request. The development team takes this very seriously. If you add in access to an API and PhantomBot would use that API improperly, we will reject the merge request. Again, the development team takes this very seriously.

You must provide test results for your change. If test results are not provided we will do one of two things. We will ask you for test results or we will just reject the change. Test results convince us that you performed a unit test and verified your change.

We reserve the right to reject a change for any reason at all. Typically, we will provide a reason but if we do not, that is at our discretion. There are some reasons for which we will reject changes, other than the ones given above (but they will be repeated):

  • Code style does not match.
  • Incompatible license/improper use of license of third party software/API.
  • No test results.
  • Potential performance issues.
  • Design changes that go against the core design philosophy.
  • Items with potential to spam or consume the outgoing message queue.
  • Poorly architected items.
  • Item is supported in chat but no update for the Control Panel.
  • Any command that would violate the Twitch Terms of Service or the Terms of Service of any provider.

You are not to harass the development team if a pull request is rejected. You may discuss and argue why you disagree with a rejection. We do ask that you stay professional and amicable in your argument and discussion.

All pull requests will be reviewed by at least two PhantomBot developers. Please be patient while two developers take the time to do so. We understand that this adds time to an approval, but it is to ensure that the development team is not missing anything.

You may delete this entire text from your Pull Request if you so desire. It is acceptable if you leave it in place as well.