From 0e53ddc2b3f19b2d8ba13eb7c557a3fe3bdbe7dd Mon Sep 17 00:00:00 2001 From: trag1c Date: Sun, 12 Feb 2023 22:38:18 +0100 Subject: [PATCH] Added Tables of Contents for CONTRIBUTING.md and CODE_OF_CONDUCT.md (#2824) --- CODE_OF_CONDUCT.md | 12 ++++++++++++ CONTRIBUTING.md | 17 ++++++++++++++--- 2 files changed, 26 insertions(+), 3 deletions(-) diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index 71074c4faa..0d9bf16fb6 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md @@ -1,5 +1,17 @@ # Contributor Covenant Code of Conduct +- [Our Pledge](#our-pledge) +- [Our Standards](#our-standards) +- [Enforcement Responsibilities](#enforcement-responsibilities) +- [Scope](#scope) +- [Enforcement](#enforcement) +- [Enforcement Guidelines](#enforcement-guidelines) + - [1. Correction](#1-correction) + - [2. Warning](#2-warning) + - [3. Temporary Ban](#3-temporary-ban) + - [4. Permanent Ban](#4-permanent-ban) +- [Attribution](#attribution) + ## Our Pledge We as members, contributors, and leaders pledge to make participation in our diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f73c4c9731..812f12b610 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,7 +2,18 @@ Welcome! We're happy to have you here. Thank you in advance for your contribution to Ruff. -## The basics +- [The Basics](#the-basics) + - [Prerequisites](#prerequisites) + - [Development](#development) + - [Project Structure](#project-structure) + - [Example: Adding a new lint rule](#example-adding-a-new-lint-rule) + - [Rule naming convention](#rule-naming-convention) + - [Example: Adding a new configuration option](#example-adding-a-new-configuration-option) +- [MkDocs](#mkdocs) +- [Release Process](#release-process) +- [Benchmarks](#benchmarks) + +## The Basics Ruff welcomes contributions in the form of Pull Requests. @@ -73,7 +84,7 @@ pre-commit run --all-files Your Pull Request will be reviewed by a maintainer, which may involve a few rounds of iteration prior to merging. -### Project structure +### Project Structure Ruff is structured as a monorepo with a [flat crate structure](https://matklad.github.io/2021/08/22/large-rust-workspaces.html), such that all crates are contained in a flat `crates` directory. @@ -190,7 +201,7 @@ To preview any changes to the documentation locally: The documentation should then be available locally at [http://127.0.0.1:8000/docs/](http://127.0.0.1:8000/docs/). -## Release process +## Release Process As of now, Ruff has an ad hoc release process: releases are cut with high frequency via GitHub Actions, which automatically generates the appropriate wheels across architectures and publishes