Skip to content

Commit a45779d

Browse files
committed
There are other ways than just code to contribute to bash_unit.
1 parent 7989c24 commit a45779d

File tree

3 files changed

+54
-6
lines changed

3 files changed

+54
-6
lines changed

CONTRIBUTING.md

Lines changed: 44 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,46 @@
1-
Be aware that bash_unit version information is extracted from git tags.
2-
If you need to deliver a versionned copy of bash_unit, you will have to
3-
activate the appropriate filters so that version information is up to
4-
date.
1+
**bash unit testing enterprise edition framework for professionals ![bash_unit](img/bu_50.png)**
52

6-
To do so, run the following command on your system :
3+
If you like bash_unit and want to contribute, you can do so in one of the
4+
following ways (order might matter).
75

8-
$> git config --local include.path ../.gitconfig
6+
# Spread the word
7+
8+
Talking about bash_unit is a very welcomed contribution.
9+
10+
Share your success with bash_unit on your blog, twitter, stackoverflow...
11+
12+
Nice words to share your experience with bash_unit is always appreciated.
13+
If you want to say something nice about bash_unit but can not think of a
14+
place for that right now, just add a comment to
15+
[issue #37](https://github.com/pgrange/bash_unit/issues/37).
16+
17+
Starring the project is also appreciated.
18+
19+
# Suggest improvements
20+
21+
When you see something that is not working with bash_unit, or if you feel
22+
something is missing, open an
23+
[issue](https://github.com/pgrange/bash_unit/issues).
24+
25+
Opening issues helps improving bash_unit.
26+
27+
# Contribute code
28+
29+
If you use a tool like bash_unit, odds are high that you already heard
30+
about software development. Just code the improvement you have in mind
31+
and create a pull-request.
32+
33+
You can contribute with new features you think are missing but you can
34+
also find inspiration with the
35+
[open issues](https://github.com/pgrange/bash_unit/issues) of bash_unit.
36+
37+
See [how to contribute code](CONTRIBUTING_CODE.md).
38+
39+
# Donate
40+
41+
bash_unit is free software I develop during my (not so) free time. If you feel
42+
bash_unit is helpfull enough to you that you want to compensate for some of
43+
the time spent developing or promoting it, you can contribute with your money
44+
on liberapay:
45+
46+
[![liberapay](https://liberapay.com/assets/widgets/donate.svg)](https://liberapay.com/bash_unit/donate)

CONTRIBUTING_CODE.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
Be aware that bash_unit version information is extracted from git tags.
2+
If you need to deliver a versionned copy of bash_unit, you will have to
3+
activate the appropriate filters so that version information is up to
4+
date.
5+
6+
To do so, run the following command on your system :
7+
8+
$> git config --local include.path ../.gitconfig

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,8 @@ before continuing reading this documentation.
1010

1111
*(by the way, the documentation you are reading is itself tested with bash-unit)*
1212

13+
bash_unit is free software you may contribute to. See [CONTRIBUTING](CONTRIBUTING.md).
14+
1315
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
1416
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
1517
**Contents**

0 commit comments

Comments
 (0)