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: instructions.md
+10-7Lines changed: 10 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -52,11 +52,14 @@ To merge code from a feature branch into the `main` branch, do the following:
52
52
53
53
Replace the contents of the [README.md](./README.md) file with a beautifully-formatted Markdown file including a plain-language **description** of your project and **clear instructions**, including exact **code examples**, for:
54
54
55
-
- how a developer who wants to import your project into their own code can do so - include documentation for all functions in your package and a link to an example Python program that uses each of them.
56
-
- how a developer who wants to contribute to your project can set up the virtual environment, install dependencies, and build and test your package for themselves.
57
-
58
-
Include a [badge](https://docs.github.com/en/actions/monitoring-and-troubleshooting-workflows/adding-a-workflow-status-badge) at the top of the `README.md` file showing the result of the latest build/test workflow run.
55
+
Replace the contents of the [README.md](./README.md) file with a beautifully-formatted Markdown file including
59
56
60
-
Include the names of all teammates as links to their GitHub profiles in the README.md file.
61
-
62
-
Include a link to your package's page on the PyPI website.
57
+
- a plain-language **description** of your project, including:
58
+
- a [badge](https://docs.github.com/en/actions/monitoring-and-troubleshooting-workflows/adding-a-workflow-status-badge) at the top of the `README.md` file showing the result of the latest build/test workflow run.
59
+
- a link to your package's page on the PyPI website.
60
+
- how a developer who wants to import your project into their own code can do so - include documentation and code examples for all functions in your package and a link to an example Python program that uses each of them.
61
+
- how a developer who wants to contribute to your project can set up the virtual environment, install dependencies, and build and test your package for themselves.
62
+
- the names of all teammates as links to their GitHub profiles in the `README.md` file.
63
+
- instructions for how to configure and run all parts of your project for any developer on any platform - these instructions must work!
64
+
- instructions for how to set up any environment variables and import any starter data into the database, as necessary, for the system to operate correctly when run.
65
+
- if there are any "secret" configuration files, such as `.env` or similar files, that are not included in the version control repository, exact instructions for how to create them and what their contents should be must be supplied to the course admins by the due date.
0 commit comments