Skip to content

Commit f686e6b

Browse files
authored
Merge pull request #30 from dwave-examples/update-github-template-switch
Update contributing guidelines for github template switch and github codespaces
2 parents 13e65f4 + a4cf312 commit f686e6b

1 file changed

Lines changed: 15 additions & 12 deletions

File tree

CONTRIBUTING.md

Lines changed: 15 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,9 @@ examples by going through the repositories in
1616

1717
## Steps for Contributing
1818

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.
2222

2323
2. [Open an issue on the dwave-examples/template repository](https://github.com/dwave-examples/template/issues/new/choose)
2424
with a link to your example.
@@ -32,18 +32,18 @@ examples by going through the repositories in
3232

3333
Please make sure that your example includes the following:
3434

35-
* README.md:
36-
* We prefer .md over .rst.
35+
* `README.md`:
36+
* We prefer `.md` over `.rst`.
3737
* See this repository's [README](README.md).
3838

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.
4141

42-
* LICENSE:
42+
* `LICENSE`:
4343
* Examples should comply with the Apache 2.0 License. Please make sure that:
4444
* 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.
4747

4848
* Tests that are discoverable through `python -m unittest discover`.
4949

@@ -52,13 +52,16 @@ Python versions we currently test our examples with, please take a look at our
5252
documentation
5353
[here](https://docs.ocean.dwavesys.com/en/stable/overview/install.html).
5454

55-
Feel free to copy the `.circleci/` directory into your example's root directory.
55+
Feel free to copy the [`.circleci/`](.circleci/) directory into your example's root directory.
5656
Once approved, we will make sure that your example is set up on our CircleCI
5757
account.
5858

59+
To ensure your example runs in [GitHub Codespaces](https://docs.github.com/en/codespaces/overview),
60+
copy the [`.devcontainer/`](.devcontainer/) directory into your example's root directory.
61+
5962
### Code
6063

61-
We use the [pep8](https://www.python.org/dev/peps/pep-0008/) style guide as a baseline.
64+
We use the [PEP 8](https://www.python.org/dev/peps/pep-0008/) style guide as a baseline.
6265

6366
If your example is lengthy, we encourage modularity for ease of testing.
6467

0 commit comments

Comments
 (0)