DZone
Thanks for visiting DZone today,
Edit Profile
  • Manage Email Subscriptions
  • How to Post to DZone
  • Article Submission Guidelines
Sign Out View Profile
  • Post an Article
  • Manage My Drafts
Over 2 million developers have joined DZone.
Log In / Join
Refcards Trend Reports Events Over 2 million developers have joined DZone. Join Today! Thanks for visiting DZone today,
Edit Profile Manage Email Subscriptions Moderation Admin Console How to Post to DZone Article Submission Guidelines
View Profile
Sign Out
Refcards
Trend Reports
Events
Zones
Culture and Methodologies Agile Career Development Methodologies Team Management
Data Engineering AI/ML Big Data Data Databases IoT
Software Design and Architecture Cloud Architecture Containers Integration Microservices Performance Security
Coding Frameworks Java JavaScript Languages Tools
Testing, Deployment, and Maintenance Deployment DevOps and CI/CD Maintenance Monitoring and Observability Testing, Tools, and Frameworks
Culture and Methodologies
Agile Career Development Methodologies Team Management
Data Engineering
AI/ML Big Data Data Databases IoT
Software Design and Architecture
Cloud Architecture Containers Integration Microservices Performance Security
Coding
Frameworks Java JavaScript Languages Tools
Testing, Deployment, and Maintenance
Deployment DevOps and CI/CD Maintenance Monitoring and Observability Testing, Tools, and Frameworks
  1. DZone
  2. Testing, Deployment, and Maintenance
  3. Deployment
  4. Submitting a Project to Branch? GitHub Best Practices

Submitting a Project to Branch? GitHub Best Practices

Thinking of submitting a project to a GitHub Branch? Here are some Best Practices to consider when creating an open source project on GitHub.

Rey Riel user avatar by
Rey Riel
·
Oct. 10, 17 · Opinion
Like (6)
Save
Tweet
Share
6.46K Views

Join the DZone community and get the full member experience.

Join For Free

A couple nights ago, I had the opportunity to attend my local JavaScript Meetup here in Ottawa. Our second speaker was Simon MacDonald giving a talk entitled Maintaining Open Source while Maintaining Your Sanity. I enjoyed the talk so much I thought DZone users may benefit from some of the points Simon laid out.

Now, I'm not in any way saying these practices are a requirement in order to submit your project for approval. These are simply suggestions that will make it easier for other developers to navigate your project, and possibly even help make it better.

Include a README

Including a README file in your project is pretty essential. It should give developers looking at your project the essential information they need, including:

  • An overview of the project. This will give the developer a good idea what exactly your project is trying to accomplish.
  • A getting started section. This should be a simple set of instructions that will get the developer up-and-running with the project as quickly as possible.
  • An invitation to contribute. One of the great benefits of open source is the ability to collaborate, so if you would like other developers to help you improve your project this section will encourage that.

Include a LICENSE

While this is never mandatory, it is incredibly important in the open source community. To quote a GitHub article regarding open source licensing:

"Generally speaking, the absence of a license means that the default copyright laws apply. This means that you retain all rights to your source code and that nobody else may reproduce, distribute, or create derivative works from your work."

The absence of a license is kind of the opposite effect we try to accomplish with open source, so including an open source LICENSE is key. You can use pretty much any open source license you wish and GitHub gives you a bunch of different options when creating a repository, so have a look.

There's plenty of more information in Simon's slides about handling collaboration when you have an open source project, but I just wanted to point out the main setup points here. Feel free to have a look at the entire presentation if you want to know more about keeping your hair when maintaining open source.

Open source GitHub Open-source license Branch (computer science)

Published at DZone with permission of Rey Riel, DZone MVB. See the original article here.

Opinions expressed by DZone contributors are their own.

Popular on DZone

  • 5 Factors When Selecting a Database
  • Mind Map Reuse in Software Groups
  • Utilize OpenAI API to Extract Information From PDF Files
  • Ultimate Guide to FaceIO

Comments

Partner Resources

X

ABOUT US

  • About DZone
  • Send feedback
  • Careers
  • Sitemap

ADVERTISE

  • Advertise with DZone

CONTRIBUTE ON DZONE

  • Article Submission Guidelines
  • Become a Contributor
  • Visit the Writers' Zone

LEGAL

  • Terms of Service
  • Privacy Policy

CONTACT US

  • 600 Park Offices Drive
  • Suite 300
  • Durham, NC 27709
  • support@dzone.com
  • +1 (919) 678-0300

Let's be friends: