Skip to content

Latest commit

 

History

History
65 lines (36 loc) · 3.16 KB

CONTRIBUTING.md

File metadata and controls

65 lines (36 loc) · 3.16 KB

How to contribute to Original Birds

Are you a legacy verified Twitter user missing your checkmark?

Do not report this as a bug.

It’s possible that we have holes in our verified users list. As mentioned on our website, we are not a verification business. However, if you believe you have sufficient proof such as a Wayback Machine link (more than a screenshot), then email us at "open.birds.official at gmail dot com" with "Original Birds Data Rectification" in the subject line.

Did you find a bug?

  • Do not open up a GitHub issue if the bug is a security vulnerability. Refer to our security policy.

  • Ensure the bug was not already reported by searching on GitHub under Issues.

  • If you do not have a GitHub account then tweet us a bug report @RealOpenBirds.

  • If you're unable to find an open issue addressing the problem, open a new one. Be sure to include a title and clear description, as much relevant information as possible, and steps to reproduce the error or a screenshot/video demonstrating the expected behavior that is not occurring.

  • If possible, use the relevant bug report template to create the issue.

Did you write a patch that fixes a bug?

  • Open a new GitHub pull request with the patch.

  • Ensure the pull request description clearly describes the problem and solution.

    • Include the relevant issue number.
    • Don't forget to test your modified extension!
    • Make sure you're passing CodeQL and ESLint.
    • Include your Twitter handle in the comments.

  • If you fix a bug, then we'll add you to our contributors list!

Did you fix whitespace, format code, or make a purely cosmetic patch?

  • Cosmetic changes to popup.html are welcome and encouraged. (Try to stay within using JQuery UI but we'll make exceptions for sleek designs.)

  • Changes that are cosmetic in nature and do not add anything substantial to the stability, functionality, or testability of Original Birds will generally not be accepted.

Do you intend to add a new feature or change an existing one?

  • Ensure the feature was not already requested by searching on GitHub under Issues.

  • If you're unable to find an open issue requesting the feature, open a new one.

  • Fork this repository and make changes.

  • When you are finished with your changes, open a new GitHub pull request.

  • Ensure the pull request description clearly describes the problem and solution.

    • Include the relevant issue number.
    • Don't forget to test your modified extension!
    • Make sure you're passing CodeQL and ESLint.
    • Include your Twitter handle in the comments.

  • If we approve the change, then we'll add you to our contributors list!

Thanks! ❤️ ❤️ ❤️

Open Birds Team