Skip to content
This repository has been archived by the owner on Dec 13, 2024. It is now read-only.

Latest commit

 

History

History
36 lines (18 loc) · 2.87 KB

Reporting bugs, making edits and improving Learn.md

File metadata and controls

36 lines (18 loc) · 2.87 KB

How can I edit copy in a lesson?

At the top of the lesson you should see a button to Edit Lesson. This will open the text of the lesson in an editor. Add your contribution and then click submit to open a pull request with your change.

open edit

edit lesson

Once the curriculum team reviews your open pull request, and if they agree with the change, they will merge it in. You'll get to contribute to the curriculum and pick up some nice open source contribution cred at the same time. Once your change is merged in you will be notified via email. If your change was rejected for one reason, or another, you will also receive an email.

When should I edit copy in a lesson?

Use this editor whenever you see an issue in the content of the lesson. It could be a misspelled word, or a concept that could use further clarification.

How do I raise an issue with a lab or lesson?

At the top of the lesson you should see a button to Raise an Issue. This button will open an issue on the canonical github repository for the lesson.

raise issue

Once you’ve filled out the issue with detailed information, click submit. The curriculum team will be notified that there is an open issue on the lesson’s repository. They may follow up with you on the issue in Github.

When should I raise an issue?

Use the Raise an Issue button when there is an issue specific to the lab or lesson. An example would be if there is an issue with the spec file in a lab. This is an issue you can’t fix by editing the content, and it’s not related to the Learn software. The best way to log it is on the actual lesson repository (using the Raise an Issue button), so all issues related to a lesson are housed in the same location.

Note: Do not open a GitHub issue on the lesson repository if you are having a problem with the IDE or your local environment, or if there is an issue with the Learn software that is not lesson specific. You will not receive assistance for those issues via this avenue. For IDE or environment issues, use Ask a Question on Learn to contact a Learn Expert.

How do I report a bug?

To report a bug please use the Ask A Question feature and a Learn Expert will assist you. If the Learn Expert is unable to solve the issue, they will log a ticket with our Support team on your behalf. If the issue requires follow-up, the Support team will reach out to you via email. Be explicit with your bug report to the Learn Expert. Provide reproduction steps, and as much context as you can. If possible, send a screenshot of the bug.

When should I report a bug?

Report a bug through Ask A Question when there is an issue with the Learn software that is not related to specific lesson content.