How to contribute

Interested in contributing to proselint? Great — there are plenty of ways you can help. In the following sections, we describe how you can help us build proselint into the greatest writing tool in the world.

Coding

Have coding skills? You can:

  • Implement a new piece of advice in the linter. In our issue tracker on GitHub, we maintain an ever-growing list of rules that have been extracted from expert advice on writing. Some of these are one-liners that will take only a moment to complete; others are full-blown research projects. Use existing checks as a guide for creating your own. Then open a pull request.
  • Create a plugin for a new text editor. We currently have a plugin for Sublime Text plugin and a web editor. Many more are needed, most notably Microsoft Word, emacs, vim, and Google Docs.
  • Fix bugs.
  • Improve performance.
  • Write tests. Our test coverage is too low. Keeping out false alarms is key to the tool's success and anything we can do to uncover false alarms and prevent regressions is thus key to the tool's success.

Writing and editing

Have writing or editing skills? You can:

  • Extract rules from expert sources of advice. Read through some entries of a book like Garners Modern American Usage find rules that are feasible to implement in code, and then open an issue on GitHub. Here's an example of a successfully extracted rule. And here's a list of sources from which rules can be extracted.
  • Find false alarms. Run proselint over your favorite books or magazine articles — maybe even some of your own writing, and find places where proselint says that there is an error, but in reality, there is none. Open an issue on GitHub describing the problem.
  • Improve the copy on this website. Or write documentation in the code.

Donations

Looking to donate to an open-source software and research project? We accept donations via PayPal.


For questions and feature requests, write to us at hello@proselint.com.