Skip to content

Commit 6024031

Browse files
update contributions guidelines (#1513)
## Changes - Bring formatting code section after the Code Formatting guideline text --------- Co-authored-by: Paul Finlay <50180049+doctorperceptron@users.noreply.github.com>
1 parent 24a67f2 commit 6024031

1 file changed

Lines changed: 24 additions & 21 deletions

File tree

documentation/contributing.md

Lines changed: 24 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -4,25 +4,27 @@ This document provides comprehensive guidelines for contributing to the PennyLan
44

55
## Table of Contents
66

7-
- [Getting Started](#getting-started)
8-
- [Cloning or Forking the Repository](#cloning-or-forking-the-repository)
9-
- [Creating a New Demo](#creating-a-new-demo)
10-
- [Using the QML CLI Tool](#using-the-qml-cli-tool)
11-
- [Manually Creating a Demo](#manually-creating-a-demo)
12-
- [Tutorial Content Guidelines](#tutorial-content-guidelines)
13-
- [General Guidelines](#general-guidelines)
14-
- [Image Guidelines](#image-guidelines)
15-
- [File Size and Format](#file-size-and-format)
16-
- [Dimensions](#dimensions)
17-
- [Metadata Guidelines](#metadata-guidelines)
18-
- [Example `metadata.json` Structure](#example-metadatajson-structure)
19-
- [Validate Your Metadata File](#validate-your-metadata-file)
20-
- [Dependency Management](#dependency-management)
21-
- [Building and Testing Locally](#building-and-testing-locally)
22-
- [Building a Demo in HTML Format](#building-a-demo-in-html-format)
23-
- [Building a Demo in JSON Format](#building-a-demo-in-json-format)
24-
- [Support](#support)
25-
- [License](#license)
7+
- [Contributing to PennyLane Demos](#contributing-to-pennylane-demos)
8+
- [Table of Contents](#table-of-contents)
9+
- [Getting Started](#getting-started)
10+
- [Cloning or Forking the Repository](#cloning-or-forking-the-repository)
11+
- [Creating a New Demo](#creating-a-new-demo)
12+
- [Using the QML CLI Tool](#using-the-qml-cli-tool)
13+
- [Manually Creating a Demo](#manually-creating-a-demo)
14+
- [Tutorial Content Guidelines](#tutorial-content-guidelines)
15+
- [General Guidelines](#general-guidelines)
16+
- [Image Guidelines](#image-guidelines)
17+
- [File Size and Format](#file-size-and-format)
18+
- [Dimensions](#dimensions)
19+
- [Metadata Guidelines](#metadata-guidelines)
20+
- [Example `metadata.json` Structure](#example-metadatajson-structure)
21+
- [Validate Your Metadata File](#validate-your-metadata-file)
22+
- [Dependency Management](#dependency-management)
23+
- [Building and Testing Locally](#building-and-testing-locally)
24+
- [Building a Demo in HTML Format](#building-a-demo-in-html-format)
25+
- [Building a Demo in JSON Format](#building-a-demo-in-json-format)
26+
- [Support](#support)
27+
- [License](#license)
2628

2729
## Getting Started
2830

@@ -88,12 +90,13 @@ While you are encouraged to be creative with your demo, please keep the followin
8890
- **LaTeX Macros:** Avoid using LaTeX macros within your comments. Even if they appear to work in development, they will not be displayed correctly once the demo is published.
8991
- **Author Information:** Include the author's information in the metadata.json file. See the metadata guidelines below.
9092
- **Code Formatting:** Before submitting, run your script through the [Black Python formatter](https://github.com/psf/black):
91-
- **Referencing Other Demos in `demo.py`:** You can reference other demos in your `demo.py` file using ``:doc:\`demos/<demo_name>\``` syntax. This will create a link to the specified demo in the documentation. For example, to reference the `tutorial_qft` demo, use ``:doc:\`demos/tutorial_qft\``` .
92-
9393
```bash
9494
pip install black
9595
black -l 100 /demonstrations_v2/tutorial_your_demo/demo.py
9696
```
97+
- **Referencing Other Demos in `demo.py`:** You can reference other demos in your `demo.py` file using ``:doc:\`demos/<demo_name>\``` syntax. This will create a link to the specified demo in the documentation. For example, to reference the `tutorial_qft` demo, use ``:doc:\`demos/tutorial_qft\``` .
98+
99+
97100
98101
## Image Guidelines
99102

0 commit comments

Comments
 (0)