Skip to content

Latest commit

 

History

History
102 lines (62 loc) · 3.05 KB

File metadata and controls

102 lines (62 loc) · 3.05 KB

GitHub Useful Information Packet

Table of Contents

  1. Build Project
  2. Markdown Files
  3. Action and Workflows
  4. License
  5. Label
  6. Open Source Project
  7. Tips

What is GitHub


Build Project

Requirement Before the Contribution

Before you to contribute to an open-source project, please read through readme, contribution, and code of conduct files, if available. They will help you to learn how to install the file, how to contribute, and how to hold a respectful and harassment-free space for all project participants.


Markdown Files


Action and Workflows


License

License a Repository

Licensing a Repository allows the others to be free to use, change, and distribute the open source software. You can choose an open source license from here.

Before Creating a New Project

When you create a new project, select Choose a license.

After Created a New Project

If you already created a project, you can add a license to a repository.

  1. Create a new file named LICENSE or LICENSE.md.
  2. Click Choose a license template button to the right of the file name field.
  3. Choose a license to add to your project and click Review and submit button. When you commit, if your current branch is the default branch, then you should create a new branch.

License Badges

If the badge is not in your README.md, please add license badge in your markdown. You can find the code here. If you want to find more license badges, use Shields.io to add your license badge.


Label


Open Source Project

  • Beginners
  • Open Source iOS Apps

Tips

NPM is the largest software registry with 800,000 code packages. When you are sharing the software in the open-source, you would use npm.

Configuring NPM

$ npm install

Information Packets