You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+15-12Lines changed: 15 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -16,9 +16,9 @@ examples by going through the repositories in
16
16
17
17
## Steps for Contributing
18
18
19
-
1.Clone this repository for a basic template from which to implement your
20
-
example. Alternatively, clone one of our existing examples and modify that
21
-
instead.
19
+
1.Follow GitHub's instructions to [create a repository from a template](https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-repository-from-a-template).
20
+
Alternatively, clone this repository (or one of our existing examples) as a
21
+
starting point from which to implement your example.
22
22
23
23
2.[Open an issue on the dwave-examples/template repository](https://github.com/dwave-examples/template/issues/new/choose)
24
24
with a link to your example.
@@ -32,18 +32,18 @@ examples by going through the repositories in
32
32
33
33
Please make sure that your example includes the following:
34
34
35
-
* README.md:
36
-
* We prefer .md over .rst.
35
+
*`README.md`:
36
+
* We prefer `.md` over `.rst`.
37
37
* See this repository's [README](README.md).
38
38
39
-
* requirements.txt:
40
-
* dwave-ocean-sdk should be unpinned and lower bounded.
39
+
*`requirements.txt`:
40
+
*`dwave-ocean-sdk` should be unpinned and lower bounded.
41
41
42
-
* LICENSE:
42
+
*`LICENSE`:
43
43
* Examples should comply with the Apache 2.0 License. Please make sure that:
44
44
* All source and test files include a license header (as shown in
45
-
[demo_name.py](demo_name.py))
46
-
* The [LICENSE](LICENSE) file is included in your root directory.
45
+
[`demo_name.py`](demo_name.py))
46
+
* The [`LICENSE`](LICENSE) file is included in your root directory.
47
47
48
48
* Tests that are discoverable through `python -m unittest discover`.
49
49
@@ -52,13 +52,16 @@ Python versions we currently test our examples with, please take a look at our
0 commit comments