You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: _posts/2017-4-27-open-source-projects.md
+13-6Lines changed: 13 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,12 +1,12 @@
1
1
---
2
2
layout: post
3
-
title: "Launching a successful open source project"
3
+
title: "A Successful Open Source Project"
4
4
tags: hpc software
5
5
---
6
6
7
7
# A Successful Open Source Project
8
8
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.
10
10
11
11
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.
12
12
@@ -22,10 +22,17 @@ This is one of the easiest ways to know if this is a serious open source project
22
22
## 3. CI badges
23
23
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:
24
24
25
-
> Image of CI badges
25
+

26
+
27
+
A great list of badges can be found at: [http://shields.io/](http://shields.io/)
26
28
27
29
## 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
29
37
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/).
0 commit comments