From 59bd26e62f6fb78599be9e88cd90329daa7a11a5 Mon Sep 17 00:00:00 2001 From: ethan <41884812+esmith164@users.noreply.github.com> Date: Wed, 25 Sep 2024 18:03:39 -0400 Subject: [PATCH] Update README.md --- README.md | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 8b26c83..00779a9 100644 --- a/README.md +++ b/README.md @@ -102,9 +102,16 @@ inconsistencies (that aren't a result of legacy APIs) file an issue. ## Contribution Guidelines - Ensure your changes pass the tests below. -- To ensure the code follows Deno's formatting guidelines, use the built-in deno fmt command. This will automatically format your TypeScript files to match Deno's code style. Run: ``sh deno fmt`` +- To ensure the code follows Deno's formatting guidelines, use the built-in deno fmt command. This will automatically format your TypeScript files to match Deno's code style. +```sh +deno fmt +``` +-Before submitting any pull requests, make sure to run deno fmt to keep the repository consistent with the project's style - When implementing new features for Deno DOM, ensure that the standard algorithm outlined by the [DOM Living Standard](https://dom.spec.whatwg.org/) is followed. Any deviations from the spec should be documented clearly in the code and pull request descriptions. +## Feature Compatiblity +If a feature relies on new JavaScript capabilities (e.g., ES6+ features like optional chaining or private class members), ensure that the feature remains compatible with the target runtime (Deno). Use browser compatibility data from MDN Web Docs to check for any potential issues. + ## Running tests To run tests (excluding WPT tests) use the following for WASM