Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Tweak suggested heading a bit #539

Merged
merged 1 commit into from
Nov 8, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ maintainers judgement.
* **Purpose** - A paragraph or two summarizing the purpose of this component.
This should be oriented towards people who are new to the Open edX project.

* **Getting Started** - A section that helps developers get oriented. Unless the repo has unusual workflows, this might be as simple as linking to the `Python <https://docs.openedx.org/en/latest/developers/how-tos/get-ready-for-python-dev.html>`_ or `frontend <https://docs.openedx.org/en/latest/developers/how-tos/get-ready-for-frontend-dev.html>`_ developer how-to.
* **Getting Started with Development** - A section that helps developers get oriented. Unless the repo has unusual workflows, this might be as simple as linking to the `Python <https://docs.openedx.org/en/latest/developers/how-tos/get-ready-for-python-dev.html>`_ or `frontend <https://docs.openedx.org/en/latest/developers/how-tos/get-ready-for-frontend-dev.html>`_ developer how-to.

* **Getting Help** - A section to indicate where and how the user can get help
with the component, including how they should go about reporting issues with
Expand Down