forked from duckdb/duckdb-web
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Contrib guide: Add table of contents
- Loading branch information
Showing
1 changed file
with
18 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,22 @@ | ||
# Contributing | ||
|
||
- [Contributing](#contributing) | ||
- [Code of Conduct](#code-of-conduct) | ||
- [Contributing to the DuckDB Documentation](#contributing-to-the-duckdb-documentation) | ||
- [Eligibility](#eligibility) | ||
- [Adding a New Page](#adding-a-new-page) | ||
- [Style Guide](#style-guide) | ||
- [Formatting](#formatting) | ||
- [Headers](#headers) | ||
- [SQL Style](#sql-style) | ||
- [Python Style](#python-style) | ||
- [Links](#links) | ||
- [Spelling](#spelling) | ||
- [Example Code Snippets](#example-code-snippets) | ||
- [Cross-References](#cross-references) | ||
- [Achive and Generated Pages](#achive-and-generated-pages) | ||
- [Notice](#notice) | ||
|
||
## Code of Conduct | ||
|
||
This project and everyone participating in it is governed by a [Code of Conduct](code_of_conduct.md). By participating, you are expected to uphold this code. Please report unacceptable behavior to [[email protected]](mailto:[email protected]). | ||
|
@@ -66,7 +83,7 @@ Some of this style guide is automated with GitHub Actions, but feel free to run | |
|
||
* Use **4 spaces** for indentation. | ||
|
||
## Links | ||
### Links | ||
|
||
* Please avoid using the term "here" for links (e.g., "for more details, click [here](https://example.org/)" should be avoided). For the rationale, see a [detailed explanation on why your links should never say "click here"](https://uxmovement.com/content/why-your-links-should-never-say-click-here/). | ||
|
||
|