4.4 KiB
| layout | title | following |
|---|---|---|
| page | Using the Templates | _articles/project-lead-guide/featured-projects.md |
We've created a set of templates to help you get started on your own GitHub project repository. You'll need to fork or clone the repository (or repo) to start using the templates. A fork is your own copy of a GitHub repository that you can edit and change however you like. A repository is a collection of files and history of your project. GitHub helps people work together and collaborate around a project.
This exercise will walk you through forking the repo.
If you already have a project repository, take a quick look at the template before you move on to the next section.
Template: https://github.com/acabunoc/mozsprint-repo-template
1. Fork the repo
To fork the templates, click on the Fork button on the repository page. It should be in the top right corner.
You'll see something like this:
You should now have your own version of the templates in your account. You should be able to find it at https://github.com/[YOUR GITHUB USERNAME]/mozsprint-repo-template.
2. Update your settings
To use this repository for your own project, it should be named properly!
Go to the settings tab in your fork. It should be rightmost tab in the repository. You can also go to the url https://github.com/[YOUR GITHUB USERNAME]/mozsprint-repo-template/settings.
Enter your new repository name.
While you're in settings, enable issues. Issues are vital for discussion and reporting around your project.
3. Edit the templates in your fork
You can edit the templates right in the GitHub website! To get to the editor, click on any of the files (let's start with README.md), then click on the edit icon in the top right-hand corner.
In the editor, you can Preview changes.
When you're ready to save your changes, scroll down to a section called Commit changes. Add a message summarizing your change. Then click on the green Commit changes button.
Now you have templates and a way to edit them! Keep reading to see how you can make your repository more contributor friendly.
4. Create issues
Each issue should be a small chunk of work someone can do during the sprint. It's best to have a range of issues with different levels of difficulty and types of contributions.
5. Add a mozsprint label
Create a label called mozsprint
Add the mozsprint label to the issues people can work on during #mozsprint.
Further Reading
- Forking - GitHub Guides
- Get your project online - Open Leadership Training Series
- Collaborate with GitHub - Open Leadership Training Series