Skip to content

Latest commit

 

History

History
79 lines (49 loc) · 3.58 KB

CONTRIBUTING.md

File metadata and controls

79 lines (49 loc) · 3.58 KB
Raw

Contributing

In Faraday we always welcome new ideas and features, however we also have to ensure that the overall code quality stays on reasonable levels. For this reason, before adding any contribution to Faraday, we highly recommend reading this quick guide to ensure your PR can be reviewed and approved as quickly as possible.

We are past our 1.0 release, and follow Semantic Versioning. If your patch includes changes that break compatibility, note that in the Pull Request, so we can add it to the Changelog.

Policy on inclusive language

You have read our Code of Conduct, which includes a note about inclusive language. This section tries to make that actionable.

Faraday has a large and diverse userbase. To make Faraday a pleasant and effective experience for everyone, we use inclusive language.

These resources can help:

  • Google's tutorial Writing inclusive documentation teaches by example, how to reword non-inclusive things.
  • Linux kernel mailing list's Coding Style: Inclusive Terminology said "Add no new instances of non-inclusive words, here is a list of words not include new ones of."
  • Linguistic Society of America published Guidelines for Inclusive Language which concluded: "We encourage all linguists to consider the possible reactions of their potential audience to their writing and, in so doing, to choose expository practices and content that is positive, inclusive, and respectful."

This project attempts to improve in these areas. Join us in doing that important work.

If you want to privately raise any breach to this policy with the Faraday team, feel free to reach out to @iMacTia and @olleolleolle on Twitter.

Required Checks

Before pushing your code and opening a PR, we recommend you run the following checks to avoid our GitHub Actions Workflow to block your contribution.

# Run unit tests and check code coverage
$ bundle exec rspec

# Check code style
$ bundle exec rubocop

New Features

When adding a feature in Faraday:

  1. also add tests to cover your new feature.
  2. if the feature is for an adapter, the attempt must be made to add the same feature to all other adapters as well.
  3. start opening an issue describing how the new feature will work, and only after receiving the green light by the core team start working on the PR.

New Middleware & Adapters

We prefer new adapters and middlewares to be added as separate gems. We can link to such gems from this project.

This goes for the faraday_middleware project as well.

We encourage adapters that:

  1. support SSL & streaming;
  2. are proven and may have better performance than existing ones; or
  3. have features not present in included adapters.

Changes to the Faraday Docs

The Faraday Docs are included in the Faraday repository, under the /docs folder and deployed to GitHub Pages. If you want to apply changes to it, please test it locally before opening your PR. You can find more information in the Faraday Docs README, including how to preview changes locally.