Skip to content

Latest commit

 

History

History
69 lines (49 loc) · 3.03 KB

CONTRIBUTING.md

File metadata and controls

69 lines (49 loc) · 3.03 KB
Raw

This guide forked from https://github.com/js-n/CONTRIBUTING.md (many thanks)

Request for contributions

Please contribute to this repository if any of the following is true:

  • You know of a case that fails the tests but shouldn't
  • You have more test data to contribute
  • You want to help improve documentation or other parts of the project
  • You are human (or a sufficiently advanced life-form capable of demonstrating conscious empathy)

How to contribute

Prerequisites:

In particular, this community seeks the following types of contributions:

  • Test Data: ./test/data/webview.js and ./test/data/not-webview.js could use more data!
  • Rules: The regex rules for testing might grow out of date

Conduct

We are committed to providing a friendly, safe and welcoming environment for all, regardless of gender, sexual orientation, disability, ethnicity, religion, or similar personal characteristic.

On IRC/Slack/Github, please avoid using overtly sexual nicknames or other nicknames that might detract from a friendly, safe and welcoming environment for all.

Please be kind and courteous. There's no need to be mean or rude. Respect that people have differences of opinion and that every design or implementation choice carries a trade-off and numerous costs. There is seldom a right answer, merely an optimal answer given a set of values and circumstances.

Please keep unstructured critique to a minimum. If you have solid ideas you want to experiment with, make a fork and see how it works.

We will exclude you from interaction if you insult, demean or harass anyone. That is not welcome behavior. We interpret the term "harassment" as including the definition in the Citizen Code of Conduct; if you have any lack of clarity about what might be included in that concept, please read their definition. In particular, we don't tolerate behavior that excludes people in socially marginalized groups.

Private harassment is also unacceptable. No matter who you are, if you feel you have been or are being harassed or made uncomfortable by a community member, please contact one of the channel ops, project maintainers, or any of the core team immediately. Whether you're a regular contributor or a newcomer, we care about making this community a safe place for you and we've got your back.

Likewise any spamming, trolling, flaming, baiting or other attention-stealing behavior is not welcome.

Communication

GitHub issues and pull-requests are the primary way for communicating about specific proposed changes to this project.

Please follow the conduct guidelines above. Language issues are often contentious and we'd like to keep discussion brief, civil and focused on what we're actually doing, not wandering off into too much imaginary stuff.

Frequently Asked Questions

TBD