Skip to content

Latest commit

 

History

History
231 lines (187 loc) · 9.08 KB

contributing.md

File metadata and controls

231 lines (187 loc) · 9.08 KB
Raw

Contributing Guide

Thanks for your interest in contributing to express-rate-limit! This guide will show you how to set up your environment and contribute to this library.

Set Up

First, you need to install and be familiar the following:

  • git: Here is a great guide by GitHub on installing and getting started with Git.
  • node and npm: This guide will help you install Node and npm. The recommended method is using the n version manager if you are on MacOS or Linux. Make sure you are using the active LTS version of Node.

Once you have installed the above, follow these instructions to fork and clone the repository (express-rate-limit/express-rate-limit).

Once you have forked and cloned the repository, you can pick out an issue you want to fix/implement!

Making Changes

Once you have cloned the repository to your computer (say, in ~/Code/express-rate-limit) and picked the issue you want to tackle, create a branch based off the next branch:

> git switch next
> git switch --create branch-name

While naming your branch, make sure the name is short and self explanatory.

Once you have created a branch, you can start coding!

The library is written in Typescript and supports Node 16, 18 and 20. The code is arranged as follows:

express-rate-limit.
├── config
│  ├── husky
│  │  └── pre-commit
│  └── jest.json
├── source
│  ├── headers.ts
│  ├── index.ts
│  ├── lib.ts
│  ├── memory-store.ts
│  ├── types.ts
│  └── validations.ts
├── test
│  ├── external
│  │  ├── imports
│  │  │  └── ...
│  │  ├── stores
│  │  │  └── ...
│  │  └── run-all-tests
│  └── library
│     ├── helpers
│     │  └── create-server.ts
│     ├── headers-test.ts
│     ├── memory-store-test.ts
│     ├── middleware-test.ts
│     ├── options-test.ts
│     └── validation-test.ts
├── changelog.md
├── contributing.md
├── license.md
├── package-lock.json
├── package.json
├── readme.md
└── tsconfig.json

Most files have a little description of what they do at the top.

./

  • package.json: Node package information.
  • package-lock.json: npm lock file, please do not modify manually.
  • tsconfig.json: The TSC configuration for this project.
  • changelog.md: A list of changes that have been made in each version.
  • contributing.md: This file, helps contributors get started.
  • license.md: Tells people how they can use this package.
  • readme.md: The file everyone should read before using the package. Contains installation and usage instructions and the API reference.

source/

  • source/index.ts: Exports the rateLimit function as the default export from source/lib.ts, and types from source/types.ts.
  • source/lib.ts: The option parser and rate limiting middleware.
  • source/types.ts: Typescript types for the library.
  • source/headers.ts: The header parsing functions.
  • source/validations.ts: The validation checks built into the library.
  • source/memory-store.ts: The default, built-in memory store for the rate limiter.

test/library/

  • test/library/helpers/create-server.ts: Helper function to create an Express server and register the middleware passed to it.
  • test/library/options-test.ts: Ensures the library can parse options correctly.
  • test/library/headers-test.ts: Ensures that the middleware returns the correct headers.
  • test/library/middleware-test.ts: Ensures the middleware works correctly with in various different situations.
  • test/library/memory-store-test.ts: Tests the default, built-in memory store.
  • test/library/validation-test.ts: Ensures the validations work.

test/external/

  • test/external/imports/*: Ensures the library can be imported in several different environments (js-cjs, js-esm, ts-cjs, ts-esm).
  • test/external/stores/*: Ensures the library works with several external stores (redis, mongo, memcached, precise).
  • test/external/run-all-tests: Sets up and then runs all external tests.

config/

  • config/husky/pre-commit: The bash script to run just before someone runs git commit.
  • config/jest.json: The configuration for jest, the test runner.

Documentation and testing

When adding a new feature/fixing a bug, please add/update the readme and changelog as well as add tests for the same. Also make sure the codebase passes the linter and library tests by running npm test. Note thaat running npm run format will automatically resolve most style/lint issues.

Note that the external tests require various datastores and take more time to execute. Typically they are run only on GitHub Actions. If desired, you may run these tests locally by running npm run test:ext

Once you have made changes to the code, you will want to commit (basically, Git's version of save) the changes. To commit the changes you have made locally:

> git add this/folder that-file.js
> git commit --message 'commit-message'

While writing the commit-message, try to follow the below guidelines:

  1. Prefix the message with type:, where type is one of the following dependending on what the commit does:
    • fix: Introduces a bug fix.
    • feat: Adds a new feature.
    • test: Any change related to tests.
    • perf: Any performance related change.
    • meta: Any change related to the build process, workflows, issue templates, etc.
    • refc: Any refactoring work.
    • docs: Any documentation related changes.
  2. Keep the first line brief, and less than 60 characters.
  3. Try describing the change in detail in a new paragraph (double newline after the first line).

When you commit files, husky and lint-staged will automatically lint the code and fix most issues. In case an error is not automatically fixable, they will cancel the commit. Please fix the errors before committing the changes. If you still wish to commit the changes, prefix the git commit command with HUSKY=0, like so:

> HUSKY=0 git commit --message 'commit-message'

Contributing Changes

Once you have committed your changes, you will want to push (basically, publish your changes to GitHub) your commits. To push your changes to your fork:

> git push origin branch-name

If there are changes made to the main branch of the express-rate-limit/express-rate-limit repository, you may wish to merge those changes into your branch. To do so, you can run the following commands:

> git fetch upstream main
> git merge upstream/main

This will automatically add the changes from main branch of the express-rate-limit/express-rate-limit repository to the current branch. If you encounter any merge conflicts, follow this guide to resolve them.

Once you have pushed your changes to your fork, follow these instructions to open a pull request:

Once you have submitted a pull request, the maintainers of the repository will review your pull requests. Whenever a maintainer reviews a pull request they may request changes. These may be small, such as fixing a typo, or may involve substantive changes. Such requests are intended to be helpful, but at times may come across as abrupt or unhelpful, especially if they do not include concrete suggestions on how to change them. Try not to be discouraged. If you feel that a review is unfair, say so or seek the input of another project contributor. Often such comments are the result of a reviewer having taken insufficient time to review and are not ill-intended. Such difficulties can often be resolved with a bit of patience. That said, reviewers should be expected to provide helpful feedback.

In order to land, a pull request needs to be reviewed and approved by at least one maintainer and pass CI. After that, if there are no objections from other contributors, the pull request can be merged.

Congratulations and thanks for your contribution!