This project has a code of conduct. By interacting with this repository, organization, or community you agree to abide by its terms.
We’re excited that you’re interested in contributing! Take a moment to read the following guidelines.
There are several ways to contribute, not just by writing code:
As a user of this project you’re perfect for helping us improve our docs: typo corrections, error fixes, better explanations, and new examples.
Some issues lack information, aren’t reproducible, or are just invalid. Help make them easier to resolve.
We’re always looking for more opinions on discussions in the issue tracker.
Code contributions are very welcome. It’s often good to first create an issue to report a bug or suggest a new feature before creating a pull request to prevent you from doing unnecessary work.
And, if you’re raising an issue, please understand that people involved with this project often do so for fun, next to their day job; you are not entitled to free customer service.
- Search the issue tracker (including closed issues) before opening a new issue;
- Ensure you’re using the latest version of projects;
- Use a clear and descriptive title;
- Include as much information as possible: steps to reproduce the issue, error message, version, operating system, etcetera;
- The more time you put into an issue, the more we will.
- Non-trivial changes are often best discussed in an issue first, to prevent you from doing unnecessary work;
- For ambitious tasks, you should try to get your work in front of the community for feedback as soon as possible;
- New features should be accompanied with tests and documentation;
- Please, don’t include unrelated changes;
- Lint and test before submitting code by running
$ npm test; - Write a convincing description of why we should land your pull request: it’s your job to convince us.
Thanks for contributing to webfont! 👏👌✨