Skip to content

Commit e913e97

Browse files
committed
add license and other guidelines
1 parent 0a3b520 commit e913e97

File tree

4 files changed

+723
-0
lines changed

4 files changed

+723
-0
lines changed

CHANGELOG.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
### July 16, 2014 - v0.1.0
2+
3+
* Initial release (Rodrigo Fernandes)

CONTRIBUTING.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# Contributing
2+
3+
One of the great things about open source projects is that anyone can contribute code.
4+
bitbucket-scala-client is a small project and we want to encourage everyone to submit their
5+
patches freely. To help you in that process, there are several things that you should keep in mind.
6+
7+
## Use Pull Requests
8+
9+
If you want to submit code, please use a GitHub pull request.
10+
This is the fastest way for us to evaluate your code and to merge it into the code base.
11+
Please don't file an issue with snippets of code. Doing so means that we need to manually
12+
merge the changes in and update any appropriate tests. That decreases the likelihood that
13+
your code is going to get included in a timely manner. Please use pull requests.
14+
15+
## Unit Tests
16+
17+
Regardless of the changes you are making, please make sure that your pull request includes
18+
appropriate unit tests.
19+
20+
## Testing
21+
22+
Along with submitting unit tests, please make sure that you have used the built-in
23+
testing capabilities in the bitbucket-scala-client build system. At a minimum, you should
24+
run `activator test`. That generates all of the built files and runs all of the unit tests
25+
in the project.

0 commit comments

Comments
 (0)