Closed Shiro-Raven closed 2 months ago
Please complete the following checklist when submitting a PR:
[ ] Ensure that your tutorial executes correctly, and conforms to the guidelines specified in the README.
[ ] Remember to do a grammar check of the content you include.
[ ] All tutorials conform to PEP8 standards. To auto format files, simply pip install black, and then run black -l 100 path/to/file.py.
pip install black
black -l 100 path/to/file.py
When all the above are checked, delete everything above the dashed line and fill in the pull request template.
Title:
Summary:
Relevant references:
Possible Drawbacks:
Related GitHub Issues:
If you are writing a demonstration, please answer these questions to facilitate the marketing process.
GOALS — Why are we working on this now?
Eg. Promote a new PL feature or show a PL implementation of a recent paper.
AUDIENCE — Who is this for?
Eg. Chemistry researchers, PL educators, beginners in quantum computing.
KEYWORDS — What words should be included in the marketing post?
Which of the following types of documentation is most similar to your file? (more details here)
[ ] Tutorial
[ ] Demo
[ ] How-to
Before submitting
Please complete the following checklist when submitting a PR:
[ ] Ensure that your tutorial executes correctly, and conforms to the guidelines specified in the README.
[ ] Remember to do a grammar check of the content you include.
[ ] All tutorials conform to PEP8 standards. To auto format files, simply
pip install black, and then runblack -l 100 path/to/file.py.When all the above are checked, delete everything above the dashed line and fill in the pull request template.
Title:
Summary:
Relevant references:
Possible Drawbacks:
Related GitHub Issues:
If you are writing a demonstration, please answer these questions to facilitate the marketing process.
GOALS — Why are we working on this now?
Eg. Promote a new PL feature or show a PL implementation of a recent paper.
AUDIENCE — Who is this for?
Eg. Chemistry researchers, PL educators, beginners in quantum computing.
KEYWORDS — What words should be included in the marketing post?
Which of the following types of documentation is most similar to your file? (more details here)
[ ] Tutorial
[ ] Demo
[ ] How-to