Thanks for taking the time to contribute to MDN Web Docs! 🎉 This file lists some general guidelines to help you contribute effectively.
Details about publishing a release can be found in the publishing guide.
There are many ways you can help improve this repository! For example:
- Fixing a bug: we have a list of issues, or maybe you found your own.
- Reviewing a pull request: there is a list of PRs. Let us know if these look good to you.
- Localizing strings: translations are in the l10n folder. You can add your locale.
Note: Commits need to adhere to conventional commits and only fix: and feat: commits are considered.
- Updating CSS data: familiarize yourself with the CSS schema files and add missing CSS data. An additional guide is provided in the How to update the CSS JSON DB document.
You can use npm test to validate data against the schema. You might need to install the devDependencies using npm install --dev.
Not everything is enforced or validated by the schema. A few things a reviewer should pay attention to:
- Make sure
npm testreports no errors. - Double check the data using the latest specifications.
The JSON files should be formatted according to the .editorconfig file.
Please note that the compatibility data is made available under the CC0 1.0 Universal (public domain) license, so any contributions must be compatible with that license. If you're not sure about that, just ask.
If you need help with this repository or have any questions, contact the MDN team in the #mdn IRC channel on irc.mozilla.org or write us on discourse.