Skip to content

Commit b826958

Browse files
SyntaxRulesSyntaxRules
authored andcommitted
feat(post): open source projects
1 parent a851df7 commit b826958

2 files changed

Lines changed: 13 additions & 6 deletions

File tree

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
---
22
layout: post
3-
title: "Launching a successful open source project"
3+
title: "A Successful Open Source Project"
44
tags: hpc software
55
---
66

77
# A Successful Open Source Project
88

9-
Its all too common for people and companies today to put some portion of their software (aka code) on GitHub and subsequently claim they are using open source practices. Perhaps this is due to the term "open source" being used as a buzz word for management. The US government even went as far as to [mandate that 20% of its code must be open source](https://sourcecode.cio.gov/). Releasing code like this is a step in the right direction, but to truly reap the benefits of open source more effort is required.
9+
Its all too common for people and companies today to put some portion of their software (aka code) on GitHub and subsequently claim they are using open source practices. Perhaps this is due to the term "open source" being used as a buzz word that get management excited. Releasing code like this is a step in the right direction, but to truly reap the benefits of open source more effort is required.
1010

1111
When creating or selecting an open source project/library/tool there are a few certain things I always look for. Here's my list of things that every open source project should have.
1212

@@ -22,10 +22,17 @@ This is one of the easiest ways to know if this is a serious open source project
2222
## 3. CI badges
2323
These badges give users confidence that future releases and fixes wont be broken. Things like documentation badges, CI badges, and code coverage badges are all fantastic ways to show off the hard work of developers. Here are a few badges I recommend:
2424

25-
> Image of CI badges
25+
![github badges](/img/github-badges.png)
26+
27+
A great list of badges can be found at: [http://shields.io/](http://shields.io/)
2628

2729
## 4. A Package manager
28-
Python has PIP, node.js has NPM, and C# has [nuget](https://www.nuget.org/). Users know using a package manager will make their life a lot easier. Developers should strive to support at least one, more if applicable. This will simplify installation instructions and increase project visibility. (Google will find a few pages referencing your project.)
30+
Python has [PIP](https://pypi.python.org/pypi), node.js has [NPM](https://www.npmjs.com/), and C# has [nuget](https://www.nuget.org/). Users know using a package manager will make their life a lot easier. Developers should strive to support at least one, more if applicable. This will simplify installation instructions and increase project visibility. (Google will find a few pages referencing your project.)
31+
32+
# Conclusion
33+
34+
Maintaining a nice looking repo will get your code more views and put you on a path with devoted community members.
35+
36+
# References
2937

30-
10 Things to do, to get your open source project looked at:
31-
3. Issues and pull requests. If you have these and I'm thinking about using your library, I'll probably look at them. If they are long lasting bugs, thats bad, if they are well structured ehancements, thats good.
38+
[The US goverment mandates that 20% of its code must be open source](https://sourcecode.cio.gov/).

img/github-badges.png

4.62 KB
Loading

0 commit comments

Comments
 (0)