Skip to content

Making a PR

Caius Nocturne edited this page Feb 14, 2024 · 2 revisions

Here's a few things to keep in mind when making PRs for new features:

Is it standardised?

It's okay if it's not adopted by many browsers, but if it's experimental or not yet standardised, I don't want to accept those because they're hard to maintain and limited in practicality. It's better to use the property function for those.

Is it documented?

Every feature in this package has documentation and has a particular format. I don't have the time to write how it goes so feel free to try your best based on how I've already documented stuff and I'll make it fit better in the final version.

Is it tested?

It would help a lot if you added tests for the new functionality.

  • If it's a new property, make sure you have tests covering the full range of value types (and many value type combinations if its a multi-value property).
  • If it's a new value, make sure there's a test for all the properties that support this value.

Take a look at this file for an example of property tests. Feel free to ask me about stuff you're not sure about too.

Clone this wiki locally