Skip to content

Latest commit

 

History

History
142 lines (100 loc) · 4.63 KB

contributing.md

File metadata and controls

142 lines (100 loc) · 4.63 KB
Raw

Contributing

This project has a code of conduct. By interacting with this repository, organization, or community you agree to abide by its terms.

Hi! 👋 We’re excited that you’re interested in contributing! Take a moment to read the following guidelines. And thanks for contributing to micromark! 👏👌✨

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.

Contents

Ecosystem

The collective (unified) consists of several organizations and separate projects: most of them are tiny, and many of them have a utility (mdast-util-to-hast), a plugin (remark-rehype), and relate to an ecosystem (remark) and a syntax tree (mdast). Try and pick the right place to contribute to so we can help you faster.

Contributions

There’s several ways to contribute, not just by writing code.

Financial support

It’s possible to support us financially by becoming a backer or sponsor through Open Collective. With this support, we can pay for project leadership, finance non-coding work, or to do fun things for the community like getting stickers for contributors. You’ll be helping unified’s maintainers manage and improve existing projects, and additionally support our work to develop new and exciting projects, such as micromark.

Improve documentation

As a user of this project you’re perfect for helping us improve our docs. Typo corrections, error fixes, better explanations, new examples, etcetera. Anything!

Improve issues

Some issues lack information, aren’t reproducible, or are just incorrect. Help make them easier to resolve.

Give feedback on issues

We’re always looking for more opinions on discussions in the issue tracker.

Write code

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.

Support

See support.md on how to get help.

Submitting an issue

  • The issue tracker is for issues. See support.md on how to get help.
  • 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
  • The best issue report is a failing test proving it

Submitting a pull request

  • 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
  • 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

Resources

License

CC-BY-4.0 © Titus Wormer