|
1 | 1 | # Contributing
|
2 | 2 |
|
3 |
| -Thanks for taking the time to contribute to a course on GitHub Learning Lab! :robot: :heart: :balloon: |
| 3 | +Thanks for taking the time to contribute to a course on GitHub Learning Lab! :robot: :heart: :balloon: |
| 4 | + |
| 5 | +### Ways to contribute |
| 6 | + |
| 7 | +We love contributions from the community. Here are just a few of the ways you can contribute: |
| 8 | + |
| 9 | +- **Report bugs:** if you find a bug while taking the course, you may want to do a quick check of past issues to see if you can find any help there. Otherwise, create a new bug issue in this repository using the provided template. |
| 10 | +- **Answer questions:** check out the open issues in this repository and see if you can help answer learner questions. Learners also ask questions in the [GitHub community forum](https://github.community/t5/GitHub-Learning-Lab/bd-p/learn) |
| 11 | +- **Suggest changes:** this could come in the form of a new learning outcome, updates to the content, updates to the bot responses, or the logic of the course. If you'd like, you can fork the course and suggest the change that way, but most people like to talk about it first in an issue. |
| 12 | +- **Tackle an issue:** if you see an issue you would like to resolve, please feel free to fork the course and submit a PR. |
| 13 | +- **Translate a course:** if you have the ability to translate a course, we'd love to see it. Please fork the course and submit a PR. We'll need a second native speaker to confirm the translation so if you have anyone in mind, please @ mention them in your PR for a review. |
4 | 14 |
|
5 | 15 | ### What should I know before I get started?
|
6 | 16 |
|
7 |
| -You should be familiar with how Learning Lab courses are structured. To get up to speed on this, you can use the following resources: |
| 17 | +You'll want to learn more about how Learning Lab works and courses are structured. To get up to speed, use the following resources: |
8 | 18 | - take the course: [_Write a Learning Lab course_](https://lab.github.com/github/write-a-learning-lab-course)
|
9 | 19 | - read the [documentation on writing a course](https://lab.github.com/docs/writing-quickstart)
|
10 | 20 | - watch the [video on how a Learning Lab course works](https://www.youtube.com/watch?v=xaLSVcwFkiI&list=PLg7s6cbtAD147DXcVp899Fk6SegoLY9gL&index=4)
|
11 |
| -- watch the [video on `config.yml`](https://www.youtube.com/watch?v=HL8MdBsFaF4&list=PLg7s6cbtAD147DXcVp899Fk6SegoLY9gL&index=2) |
12 |
| - |
13 |
| -### Ways to contribute |
14 |
| - |
15 |
| -There are many ways you can contribute! Here are just a few: |
16 |
| -- report bugs: create an issue in this repository and follow the issue template for reporting bugs. Before you open the issue, ensure you read through the instructions to ensure you're not opening a duplicate |
17 |
| -- answer questions: some of the issues in this repository may be questions asked by a learner. Answering these questions is a :sparkles: way of helping out. You can also provide this kind of contribution in the [GitHub community forum](https://github.community/t5/GitHub-Learning-Lab/bd-p/learn) |
18 |
| -- suggest changes to the course: this could come in the form of a new learning outcome, updates to the content, updates to the bot responses, or the logic of the course |
19 |
| -- implement bug fixes or suggestions |
20 |
| - |
21 |
| -### Releasing |
22 |
| - |
23 |
| -When your course branch has been merged into `master`, the [course version](https://lab.github.com/docs/course-versioning) on Learning Lab will automatically update and any new learners will receive the updated version of the course. There are no additional requirements on your part. |
| 21 | +- watch the [video on the `config.yml`](https://www.youtube.com/watch?v=HL8MdBsFaF4&list=PLg7s6cbtAD147DXcVp899Fk6SegoLY9gL&index=2) |
24 | 22 |
|
25 | 23 | ### How to Contribute
|
26 | 24 |
|
27 | 25 | 1. Fork this repository. Optionally, create a branch in your fork.
|
28 |
| -1. Make your edits, as follows: |
29 |
| - - to change course title, tags, tagline, short description, or logic, [edit `config.yml` in the course repository](https://lab.github.com/docs/content-for-the-catalog) |
30 |
| - - to change the bot's responses, edit the corresponding [response file in the `responses/` directory](https://lab.github.com/docs/writing-responses) |
31 |
| - - to change the course's longform description in the catalog, [edit `description.md`](https://lab.github.com/docs/course-ownership-and-repositories#set-up-the-course-repositories) |
32 |
| - - to change the starter code for the learner, edit the [template repository](https://lab.github.com/docs/course-ownership-and-repositories#the-repositories) |
33 |
| -1. Commit your changes to your fork. |
| 26 | +1. In order to test your changes, you'll need to create your own draft version of the course on Learning Lab. You'll need to: |
| 27 | + - Fork the template repository to your account |
| 28 | + - Install Learning Lab on both this repository and the template repository |
| 29 | + - Go to `https://lab.github.com/{{ your-username }}/new` |
| 30 | + - This will create a draft course. You can do all of the testing while in draft, you won't need to publish the course. |
| 31 | +1. Once you've created a draft version, you can use the Course Builder to make changes. For more information on what to change, check out the [documentation](https://lab.github.com/docs/writing-quickstart) |
| 32 | +1. Commit your changes to your branch. |
34 | 33 | 1. Open a pull request with:
|
35 | 34 | - base branch: the master branch of this repository
|
36 | 35 | - compare branch: the branch containing your commits in your fork
|
37 |
| -1. Wait for a review from the Learning Lab team, which will be automatically requested |
| 36 | +1. Request a review from the Learning Lab team (this should be automatically requested) |
0 commit comments