📘
Engineering Communications Program Team Projects
Open Source Guide
Open Source Guide
  • Welcome
  • Creators
    • Reasons to create
    • Create a repository
      • Set up documentation
        • README
        • CONTRIBUTING
        • License
    • Name your project
    • Build a community
      • Communication Mediums
        • Mass Notifications
        • Formal Exchanges
        • Real-Time Messaging
      • Code of Conduct
    • Additional Resources
  • Contributors
    • Reasons to contribute
    • Find a project
      • GitHub Trending
    • Ways to contribute
    • Choose an issue
    • Read supporting documentation
    • Git Workflow
      • Fork a project
      • Create a branch
      • Add a commit
      • Submit a pull request
      • Review code
Powered by GitBook
On this page
  • README
  • CONTRIBUTING
  1. Contributors

Read supporting documentation

PreviousChoose an issueNextGit Workflow

Last updated 3 years ago

Before you dive in and make changes, you should first read the supporting documentation.

README

GitHub automatically displays the README file on the home page of the repository. Most open source projects have a detailed README section. This is a great place to start.

CONTRIBUTING

The CONTRIBUTING.md file tells you how to contribute to the project and includes standards and best practices. Here is an example.

After you read the supporting documentation and feel ready to dive in, jump into the next section to learn about how to use Git.

Example of a README file
Example of a CONTRIBUTING file
List of best practices for contributors