Hacktoberfest 2021 Guidelines

[dstaley]

Hello there! If you're reading this, you're likely looking to submit a pull request as part of Hacktoberfest. First off, thank you for wanting to contribute! We're glad you're here.

What We're Looking For

This year, we're trying something different. We have a list of areas where we'd really like to see contributions from Hacktoberfest. Those areas are as follows:

Documentation

One area that we'd love some help on is documentation! Please feel free to improve our documentation by rephrasing complicated passages, ensuring that documentation is up-to-date, and by fixing typos and grammatical errors†.

† Please note that our threshold for accepting a PR fixing typos and errors is quite high. Please do not send individual PRs fixing single errors. Instead, batch them up into a single PR.

JSDoc Comments

As our APIs have been modified, our JSDoc comments have drifted somewhat. We'd love to see PRs making sure that our JSDoc comments match our TypeScript types.

What We're Not Looking For

Due to the size of our maintainer team, there's a few categories of PRs that we're unable to accept currently:

Translations

Our maintainer team speaks English and French. As such, we're unable to adequately review PRs translating our documentation into any other languages. Furthermore, we don't have the tooling necessary to provide a language toggle for our documentation site.

Breaking API Changes

We would like to avoid any breaking API changes during Hacktoberfest. That being said, if there's a change you'd like to make that would break the API, please open a discussion topic about it prior to sending a PR. If the change is minor enough and can be appropriately reviewed within the timeframe of Hacktoberfest, we can discuss allowing your PR.

Code Style Changes

Please do not submit PRs changing our code style, or making minor readability changes that are mostly opinion-based. Simplifying code to run faster or making significant changes for readability are acceptable, but please avoid things like changing const to let or modifying our Prettier config.

Tooling Changes

Because we share a lot of tooling between our JavaScript repos, please do not submit PRs making changes without discussing it in our Discussions first. We will need to coordinate changes across all of our JavaScript repos.

---

If you have any questions, or would like to discuss a PR before working on it, please reach out to us in Discussions. We're excited you're participating in Hacktoberfest 2021. Happy hacking!