CONTRIBUTING.md

Contributor's Guide

Thanks for your interest in the project! We welcome pull requests from developers of all skill levels. To get started, simply fork the master branch on GitHub to your personal account and then clone the fork into your development environment.

If you would like to contribute but don't already have something in mind, we invite you to take a look at the issues listed under our next milestone. If you see one you'd like to work on, please leave a quick comment so that we don't end up with duplicated effort. Thanks in advance!

The core Falcon project maintainers are:

• Kurt Griffiths, Project Lead (kgriffs on GH, Gitter, and Twitter)
• John Vrbanac (jmvrbanac on GH, Gitter, and Twitter)
• Vytautas Liuolia (vytas7 on GH and Gitter, and vliuolia on Twitter)
• Nick Zaccardi (nZac on GH and Gitter)
• Federico Caselli (CaselIT on GH and Gitter)

Please don't hesitate to reach out if you have any questions, or just need a little help getting started. You can find us in falconry/dev on Gitter.

Please note that all contributors and maintainers of this project are subject to our Code of Conduct.

Pull Requests

Before submitting a pull request, please ensure you have added or updated tests as appropriate, and that all existing tests still pass with your changes. Please also ensure that your coding style follows PEP 8 and the blue formatting style.

In order to reformat your code with blue, simply issue:

$ pip install -U blue
$ blue .

You can check all this by running tox from within the Falcon project directory. Your environment must be based on CPython 3.8, 3.10 or 3.11:

$ pip install -U tox
$ tox --recreate

You may also use a CPython 3.9 environment, although in that case coverage will likely report a false positive on missing branches, and the total coverage might fall short of 100%. These issues are caused by bugs in the interpreter itself, and are unlikely to ever get fixed.

Reviews

Falcon is used in a number of mission-critical applications and is known for its stability and reliability. Therefore, we invest a lot of time in carefully reviewing PRs and working with contributors to ensure that every patch merged into the master branch is correct, complete, performant, well-documented, and appropriate.

Project maintainers review each PR for the following:

• Design. Does it do the right thing? Is the end goal well understood and correct?
• Correctness. Is the logic correct? Does it behave correctly according to the goal of the feature or bug fix?
• Fit. Is this feature or fix in keeping with the spirit of the project? Would this idea be better implemented as an add-on?
• Standards. Does this change align with approved or standards-track RFCs, de-facto standards, and currently accepted best practices?
• Tests. Does the PR implement sufficient test coverage in terms of value inputs, Python versions, and lines tested?
• Compatibility. Does it work across all of Falcon's supported Python versions and operating systems?
• Performance. Will this degrade performance for request or response handling? Are there opportunities to optimize the implementation?
• Docs. Does this impact any existing documentation or require new documentation? If so, does this PR include the aforementioned docs, and is the language friendly, clear, helpful, and grammatically correct with no misspellings? Do all docstrings conform to Google style ala sphinx.ext.napoleon?
• Dependencies. Does this PR bring in any unnecessary dependencies that would prevent us from keeping the framework lean and mean, jeopardize the reliability of the project, or significantly increase Falcon's attack service?
• Changelog. Does the PR have a changelog entry in newsfragments? Is the type correct? Try running towncrier --draft to ensure it renders correctly.

Test coverage

Pull requests must maintain 100% test coverage of all code branches. This helps ensure the quality of the Falcon framework. To check coverage before submitting a pull request:

$ tox

It is necessary to combine test coverage from multiple environments in order to account for branches in the code that are only taken for a given Python version.

Running the default sequence of tox environments generates an HTML coverage report that can be viewed by simply opening .coverage_html/index.html in a browser. This can be helpful in tracking down specific lines or branches that are missing coverage.

Debugging

We use pytest to run all of our tests. Pytest supports pdb and will break as expected on any pdb.set_trace() calls. If you would like to use pdb++ instead of the standard Python debugger, simply run the following tox environment. This environment also disables coverage checking to speed up the test run, making it ideal for quick sanity checks.

$ tox -e py3_debug

If you wish, you can customize Falcon's tox.ini to install alternative debuggers, such as ipdb or pudb.

Benchmarking

A few simple benchmarks are included with the source under falcon/bench. These can be taken as a rough measure of the performance impact (if any) that your changes have on the framework. You can run these tests by invoking one of the tox environments included for this purpose (see also the tox.ini file). For example:

$ tox -e py310_bench

Note that you may pass additional arguments via tox to the falcon-bench command:

$ tox -e py310_bench -- -h
$ tox -e py310_bench -- -b falcon -i 20000

Alternatively, you may run falcon-bench directly by creating a new virtual environment and installing falcon directly in development mode. In this example we use pyenv with pyenv-virtualenv from within a falcon source directory:

$ pyenv virtualenv 3.10.6 falcon-sandbox-310
$ pyenv shell falcon-sandbox-310
$ pip install -r requirements/bench
$ pip install -e .
$ falcon-bench

Note that benchmark results for the same code will vary between runs based on a number of factors, including overall system load and CPU scheduling. These factors may be somewhat mitigated by running the benchmarks on a Linux server dedicated to this purpose, and pinning the benchmark process to a specific CPU core.

Documentation

To check documentation changes (including docstrings), before submitting a PR, ensure the tox job builds the documentation correctly:

$ tox -e docs

# OS X
$ open docs/_build/html/index.html

# Gnome
$ gnome-open docs/_build/html/index.html

# Generic X Windows
$ xdg-open docs/_build/html/index.html

VS Code Dev Container development environment

When opening the project using the VS Code IDE, if you have Docker (or some drop-in replacement such as Podman or Colima or Rancher Desktop) installed, you can leverage the Dev Containers feature to start a container in the background with all the dependencies required to test and debug the Falcon code. VS Code integrates with the Dev Container seamlessly, which can be configured via devcontainer.json. Once you open the project in VS Code, you can execute the "Reopen in Container" command to start the Dev Container which will run the headless VS Code Server process that the local VS Code app will connect to via a published port.

Code style rules

• Docstrings are required for classes, attributes, methods, and functions. Follow the following guidelines for docstrings:
  • Docstrings should utilize the napoleon style in order to make them read well, regardless of whether they are viewed through help() or on Read the Docs.
  • Docstrings should begin with a short (~70 characters or less) summary line that ends in a period.
    • The summary line should begin immediately after the opening quotes (do not add a line break before the summary line)
    • The summary line should describe what it is if it is a class (e.g., "An asynchronous, file-like object for reading ASGI streams.")
    • The summary line should describe what it does when called, if it is a function, structured as an imperative (e.g., "Delete a header that was previously set for this response.")
  • Please try to be consistent with the way existing docstrings are formatted. In particular, note the use of single vs. double backticks as follows:
  • Double backticks
    • Inline code
    • Variables
    • Types
    • Decorators
  • Single backticks
    • Methods
    • Params
    • Attributes
• Format non-trivial comments using your GitHub nick and one of these prefixes:
  • TODO(riker): Damage report!
  • NOTE(riker): Well, that's certainly good to know.
  • PERF(riker): Travel time to the nearest starbase?
  • APPSEC(riker): In all trust, there is the possibility for betrayal.
• When catching exceptions, name the variable ex.
• Use whitespace to separate logical blocks of code and to improve readability.
• No single-character variable names except for trivial indexes when looping, or in mathematical expressions implementing well-known formulas.
• Heavily document code that is especially complex and/or clever.
• When in doubt, optimize for readability.

Changelog

We use towncrier to manage the changelog. Each PR that modifies the functionality of Falcon should include a short description in a news fragment file in the docs/_newsfragments directory.

The newsfragment file name should have the format {issue_number}.{fragment_type}.rst, where the fragment type is one of breakingchange, newandimproved, bugfix, or misc. If your PR closes another issue, then the original issue number should be used for the newsfragment; otherwise, use the PR number itself.

Commit Message Format

Falcon's commit message format uses AngularJS's style guide, reproduced here for convenience, with some minor edits for clarity.

Each commit message consists of a header, a body and a footer. The header has a special format that includes a type, a scope and a subject:

<type>(<scope>): <subject>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>

No line may exceed 100 characters. This makes it easier to read the message on GitHub as well as in various git tools.

Type

Must be one of the following:

• feat: A new feature
• fix: A bug fix
• docs: Documentation only changes
• style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
• refactor: A code change that neither fixes a bug or adds a feature
• perf: A code change that improves performance
• test: Adding missing tests
• chore: Changes to the build process or auxiliary tools and libraries such as documentation generation

Scope

The scope could be anything specifying place of the commit change. For example: $location, $browser, $compile, $rootScope, ngHref, ngClick, ngView, etc...

Subject

The subject contains succinct description of the change:

• use the imperative, present tense: "change" not "changed" nor "changes"
• don't capitalize first letter
• no dot (.) at the end

Body

Just as in the subject, use the imperative, present tense: "change" not "changed" nor "changes". The body should include the motivation for the change and contrast this with previous behavior.

Footer

The footer should contain any information about Breaking Changes and is also the place to reference GitHub issues that this commit Closes.