voidpointer11 / github-move Goto Github PK

When you add an issue template and pull request template to your repository, project contributors will automatically see the template's contents in the issue or pull request body. Templates customize and standardize the information you'd like included when contributors open issues. This information can guide contributors to include the information that allows enhancement or bug reports to be reviewed quickly and identify the information that a reviewer would need to succintly review a new pull request.

In Open Source projects, these templates make it very easy for a new contributor to your project to create a bug report, suggest a new enhancement, or potentially contribute a change. By identifying what information the new contributor should provide when creating a new issue or pull request, veteran contributors to the project can easily review and move forward with reported bugs, new enhancements, or contributed pull requests.

⌨️ Activity: Adding Issue and Pull Request template files

1. Access the Community profile pane

2. On the Issue or pull request template row, select the Add drop down and select Issue template or Pull request template

3. Edit the new template file to identify how you want issues or pull requests submitted to your project, for suggestions on what should be included in a template file, read this

4. Afer editing the template file, scroll down and click the Commit new file button

   This is committing your template file directly to master.

 - Issue templates are named: `ISSUE_TEMPLATE.md`
 - Pull Request templates are named: `PULL_REQUEST_TEMPLATE.md`

> This is committing your template file directly to `master`.

I won't respond to this issue, just close it when you are done!

Your repository has no description! Let's add one.

⌨️ Activity: Adding a project description

1. Access the Community profile pane
2. Click the Add button on the Description row.
3. Enter a description for your project in the Description field.
4. (Optional) If you have a website related to your project you can add it in the Website field.
5. Click the Save button.

I won't respond to this issue, just close it when you are done!

Step 1: Planning the move

You have a few options when moving your project to GitHub. This course will expose you to these options, help you choose a path, and then guide you down the path you have selected.

I know some people like to get straight to the point while others like more information. For those who like more information, be sure to check out the drop-downs like this one ⬇️

Where is your project today?

To give you the best information, I need to know a little about your project. In the next activity, you will apply a label to this issue to help me provide the most applicable information to help you move a project to GitHub.

⌨️ Activity: Add a label to this Issue

For this exercise, use the following table to determine which label to apply to this issue.

1. On the right side of this issue ^📖, look for a section titled Labels
2. Click the ⚙️ gear icon
3. Select the label that describes your project
4. Click the ✖️ x at the top of the label panel when you are finished

For a printable version of the steps in this course, check out the Quick Reference Guide.

Watch below for my response

After you have added the label, I will add a new comment to this issue with next steps.

Sometimes I respond too fast for the page to update! If you perform an expected action and don't see a response from me, wait a few seconds and refresh the page for your next steps.

Step 2: Prepare the project

Working with Binary files

In general, there are two types of files: text files and binary files.

Text files, like most code files, are easily tracked with Git ^📖 and are very lightweight.

However, binary files like spreadsheets, presentations with slides, and videos don't work well with Git. If your repository already has some of these files, it's best to have a plan in place before you enable Git version control.

You could choose to remove the binary files, or use another tool like git-lfs (Git Large File Storage). We won't get into detail on how to set up git-lfs in this course, but we will talk about .gitignore files next, which are key to protecting your code from becoming bloated with binaries.

Add a .gitignore

As mentioned above, there are files you won't want to store in Git. In addition to avoiding binaries, you will also want to keep build artifacts out of your version controlled code. As we convert your project to a Git repository, it should only include the source code necessary to build or compile your project.

To do this, you will create a file in your current project named .gitignore. When you switch over, Git will use the .gitignore to determine which files and directories should not be tracked under version control.

A .gitignore file should be committed into your repository in order to share the ignore rules with any other users that interact with the repository.

Since the files to be ignored are dependent on the language you are using, the open source community has contributed some great templates for .gitignore files in the github/gitignore repository.

⌨️ Activity: Prepare your repository

1. Remove any binary files from your repository.
2. In your local environment, create a .gitignore file. Use a template or create your own.

When you are finished, close this issue. I will open a new issue with the next steps. 🎉

Watch below for my response

🤖 I'm waiting for you to close this issue before moving on.

A contributing guide provides important information to those who may be interested in helping you with your project. Without a contributing guide, they might not know what you need help with, how they can get started, or how you like to communicate.

Providing the baseline expectations for a contribution to your project makes it much easier for a new user to contribute to the growth and development of your project. Identifying the processes that you expect to be followed when creating contributions to your project helps reduce the hesitation a new contributor might feel when adding a new contribution because what you are looking for in a contribution is well laid out. The contributing guide is helpful for veteran contributors as well, as it provides a reference point for their review if they are contribting to an area of the project they hadn't previously worked with.

⌨️ Activity: Adding Contributing guidelines

1. Access the Community profile pane

2. Click the Add button on the Contributing row

3. Modify your new file with contributing guidelines for your project, for ideas on what should be included in a contributing guidelines file, read this stellar documentation

4. After editing the CONTRIBUTING.md file, scroll down and click the Commit new file button.

   This is committing your CONTRIBUTING.md file directly to master.

I won't respond to this issue, just close it when you are done!

Step 3: Make the move

Having a project already stored locally enables you to move it to GitHub rather quickly. The following activity provides instructions to move your local project to GitHub using various tools. Select the tool you are most comfortable with and get importing 😄.

⌨️ Activity: Moving your local project

1. In the Code tab of this repository, copy the URL shown under Quick Setup.
2. Follow the instructions below based on what tool you'd like to use locally.

Watch below for my response

🤖 Once you push your project to GitHub, I'll provide the next steps in your journey.

Step 4: Prepare to collaborate

Public repositories on GitHub have a Community score. This score is based on the documentation, and how easy it would be for new users to help out and contribute to your project.

Your community score

Your score is currently 0 and can be seen here.

I've opened up issues for each one of the items that you should take action on, and started a milestone to help you keep track of them.

To continue with best practices for moving to GitHub, close this issue. Don't worry, the milestone will remain open so you can return to it later.

Watch below for my next response

🤖 I'm waiting for you to close this issue before moving on.

Your project doesn't have a README.md file. A README.md file is useful for telling other people why your project is useful, what they can do with your project, how they can use it, and more importantly, how they can contribute to your project.

A README is often the first item a visitor will see when visiting your repository. README files typically include information on:

• What the project does
• Why the project is useful
• How users can get started with the project
• Where users can get help with your project
• Who maintains and contributes to the project

⌨️ Activity: Adding a README

1. Access the Community profile pane

2. Click the Add button on the README row.

3. Edit the new README file to describe your projects, using the bullet points listed above ☝️

4. After editing the README file, scroll down and click the Commit new file button.

   This is committing your README file directly to master. Normally, you would create a pull request when making changes to your projects, but README files are very important on GitHub.

I won't respond to this issue, just close it when you are done!

Your repository is public but there's no License. Licenses are vital in public repositories, because they set the rules for how others are allowed to use, change, and contribute to your project.

⌨️ Activity: Adding a License

1. Access the Community profile pane

2. Click the Add button on the License row.

3. Select a license from the left side of the screen and review the license you selected.

4. Add information to the displayed fields and click the Review and submit button.

5. With your file displayed, scroll down and click the Propose new file button.

   This is adding your new file to a new branch that GitHub created for you.

6. With the Open a pull request screen displayed, click the Create pull request button.

7. If you are ready to merge (or apply) your file to the project click the Merge pull request button. If you want to share this change to your repository with someone, share the URL for this pull request or @ mention them in the comment section.

8. After clicking Merge pull request, click Confirm merge.

9. Once the merge is complete (it should happen really quickly) delete your branch by clicking Delete branch.

I won't respond to this issue, just close it when you are done!

Your repository has no Code of Conduct.

Having a Code of Conduct is really important, especially for public repositories. Instead of re-writing the wheel, I want to point you to some of the best instructions around.

⌨️ Activity: Add a Code of Conduct

1. Access the Community profile pane

2. Click the Add button on the Code of Conduct row.

3. Select a Code of Conduct from the left side of the screen and review the Code of Conduct you selected.

4. Add information to the displayed fields then click the Review and submit button.

5. With your file displayed, scroll down and click the Commit new file button.

   This is adding your new file to a new branch that GitHub created for you.

6. With the Open a pull request screen displayed, click the Create pull request button.

7. If you are ready to merge (or apply) your file to the project click the Merge pull request button. If you want to share this change to your repository with someone, share the URL for this pull request or @ mention them in the comment section.

8. After clicking Merge pull request, click Confirm merge.

9. Once the merge is complete (it should happen really quickly) delete your branch by clicking Delete branch.

I won't respond to this issue, just close it when you are done!