* `@app.patch()`
* `@app.trace()`

/// tip

You are free to use each operation (HTTP method) as you wish.

**FastAPI** doesn't enforce any specific meaning.

The information here is presented as a guideline, not a requirement.

For example, when using GraphQL you normally perform all the actions using only `POST` operations.

///

</div>

## Create a Virtual Environment { #create-a-virtual-environment }

When you start working on a Python project **for the first time**, create a virtual environment **<abbr title="there are other options, this is a simple guideline">inside your project</abbr>**.

/// tip

You only need to do this **once per project**, not every time you work.

///

//// tab | `venv`

2) Never change punctuation inside inline code, code blocks, URLs, or file paths.
3) For more details, please follow the [Chinese Copywriting Guidelines](https://github.com/sparanoid/chinese-copywriting-guidelines).

### Ellipsis

1) Keep ellipsis style consistent within each document, prefer `...` over `……`.
2) Never change ellipsis in code, URLs, or CLI examples.

can make. We therefore encourage reporting security issues with the code
contained in this repository.

If you believe you have discovered a security vulnerability, please follow the

- **Default Port**: 8080 (configurable via `fess.port` system property)
- **Log Location**: `target/fess-logs/` (dev), `/var/log/fess/` (prod)
- **Admin Login**: `admin/admin`

## Log Message Guidelines

- Format parameters as `key=value` (e.g., `sessionId={}`, `url={}`)
- Prefix with `[name]` when context identification is needed
- Use full words, not abbreviations (e.g., "documents" not "docs")

It helps developers optimize performance and gain deeper insights into their builds.

## Making your change

### Code change guidelines

Code contributions should follow these guidelines to maximize the chance of them being accepted:

* Cover your code with tests. See the [Testing guide](contributing/Testing.md) for more information.

* **Reduced review friction**: Less time spent on spelling corrections during PR reviews
* **Professional appearance**: Consistent APIs and documentation appear more polished
* **Clearer contribution guidelines**: [CONTRIBUTING.md](../../CONTRIBUTING.md) now includes this requirement

### Negative Consequences

## Developing

If you already cloned the <a href="https://github.com/fastapi/fastapi" class="external-link" target="_blank">fastapi repository</a> and you want to deep dive in the code, here are some guidelines to set up your environment.

### Virtual environment

Follow the instructions to create and activate a [virtual environment](virtual-environments.md){.internal-link target=_blank} for the internal code of `fastapi`.

Some examples of types of pull requests that are immediately helpful:

  - Fixing a bug without changing a public API.
  - Fixing or improving documentation.
  - Improvements to Maven configuration.

Guidelines for any code contributions:

1.  Any significant changes should be accompanied by tests. The project already
    has good test coverage, so look at some existing tests if you're unsure how
    to go about it.

   * {@code ClosingFuture}. But if the exception is thrown after the function creates a {@code
   * ClosingFuture}, then none of the closeable objects in that {@code ClosingFuture} will be
   * closed.
   *
   * <p>Usage guidelines for this method:
   *
   * <ul>
   *   <li>Use this method only when calling an API that returns a {@link ListenableFuture} or a