Skip to content

Commit 74881aa

Browse files
Adding a CONTRIBUTING guidelines
**Why:** * Write out my plans for where this will go. Signed-off-by: Christopher Hein <[email protected]>
1 parent 23afefc commit 74881aa

File tree

2 files changed

+36
-0
lines changed

2 files changed

+36
-0
lines changed

CONTRIBUTING.adoc

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
= Contributing
2+
3+
⭐️⭐️⭐️⭐️⭐️ First off thanks for taking the time to contribute ⭐️⭐️⭐️⭐️⭐️
4+
5+
This project is extremely simple and gives a generic way to get a version out of
6+
your `goreleaser` and `cobra` projects. All the code is contained in a single
7+
package `version.go`.
8+
9+
== Roadmap
10+
11+
If you are interested in contributing to this project here are a couple things
12+
that I would like to add.
13+
14+
1. **Issue: link:https://github.com/christopherhein/go-version/issues/1[#1]**
15+
Support for custom attributes `-X main.foobar=<blah>` and updating
16+
`goVersion.New()` to take a splat or map of addition params.
17+
2. **Issue: https://github.com/christopherhein/go-version/issues/2[#2]**
18+
Ability to Output to `yaml`
19+
3. **Issue: https://github.com/christopherhein/go-version/issues/3[#3]**
20+
Func for taking in a type string and outputting the right response
21+
+
22+
**Example:**
23+
+
24+
[source,go]
25+
----
26+
info := goVersion.New(...)
27+
info.Output('json')
28+
----
29+
4. **Issue: https://github.com/christopherhein/go-version/issues/4[#4]**
30+
Tests 😳
31+

readme.adoc

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -74,3 +74,8 @@ Version: dev
7474
Commit: <SOMEHASH>
7575
Date: <SOMEDATE>
7676
----
77+
78+
== Contributing
79+
80+
If you want to contribute check out
81+
https://github.com/christopherhein/go-version/blob/master/CONTRIBUTING.adoc

0 commit comments

Comments
 (0)