Skip to content

Latest commit

 

History

History
150 lines (108 loc) · 5.24 KB

contributing.md

File metadata and controls

150 lines (108 loc) · 5.24 KB
Raw

Contributing

This project has a Code of Conduct. By interacting with this repository or community you agree to abide by its terms.

Hi! 👋 Exciting that you’re interested in contributing! Before doing so, take a moment to read the following guidelines. And thanks for contributing to alex! 👏👌✨

Before anything else: people involved with this project often do so for fun, as volunteers, next to their day job. Please be considerate in requests for features and changes, and be patient regarding response times. Maintainers are not able to respond to individual support requests, but if you feel that something in the documentation is missing or incorrect, please let us know!

Table of Contents

Ecosystem

This project, alex, is a small wrapper around the unified ecosystem. It mainly uses retext to process natural language, with the retext-equality and retext-profanities plugins. For markdown, remark is used.

Try and pick the right place to contribute to so we can help you faster. alex handles the user’s command line experience, while the retext plugins determine the rules and recommendations.

Trying out your local changes

To see how your local changes affect alex, you can use npm link

git clone <your fork url>
cd alex
npm install
npm link
alex some-file.md

Running tests

npm test

Contributions

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

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.

Website contributions

There are ways in which our website can be improved as well, and we are open to contributions. Switch to the website branch (with git checkout website) and start contributing! Changes made to the src folder are automatically built to the dest folder.

Submitting an issue

  • The issue tracker is for issues
  • Try to find the best issue tracker (remark, retext, retext-equality, retext-profanities, or here) for your issue
  • 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