Skip to content

Commit

Permalink
Merge pull request #200 from twitter/2.0.0.M1
Browse files Browse the repository at this point in the history
Finatra version 2.0.0.M1
  • Loading branch information
cacoco committed Apr 29, 2015
2 parents 5d1d1cb + 55ac01f commit 39dc6f6
Show file tree
Hide file tree
Showing 597 changed files with 22,026 additions and 12,186 deletions.
13 changes: 4 additions & 9 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,9 +1,4 @@
logs/*
target
target/*
*.DS_Store
*.releaseBackup
release.properties
*.iml
.idea
.idea/*
classes/
target/
finatra/
sbt-launch.jar
19 changes: 15 additions & 4 deletions .travis.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,18 @@
language: scala

sudo: false
script:
- sbt test

scala:
- 2.9.2
- 2.10.4
- 2.10.5
- 2.11.6

jdk:
- openjdk7
- oraclejdk7
- oraclejdk8

script:
- travis_retry sbt ++$TRAVIS_SCALA_VERSION clean coverage test && sbt coverageAggregate

after_success:
- sbt coveralls
6 changes: 6 additions & 0 deletions ADOPTERS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
## Finatra Adopters

Twitter isn't the only company using Finatra. We're sure the following list isn't complete, so please [let us know][0] if your company should be included or if you'd like us to feature a link to a blog post or article about how you're Finatra. Or, you can add the links yourself (please use **HTTPS** urls if possible) and [submit a pull request][1]!

[0]: https://twitter.com/finatra
[1]: https://github.com/twitter/finatra/blob/master/CONTRIBUTING.md
83 changes: 83 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,83 @@
# How to Contribute

We'd love to get patches from you!

## Building dependencies

We are not currently publishing snapshots for Finatra's dependencies, which
means that it may be necessary to build and publish the `develop` branches of dependencies locally
in order to work on Finatra's `master` branch. To do this you should clone [TwitterServer][twitter-server-repo],
[Finagle][finagle-repo], and [Util][util-repo], check out their `develop` branches, and run `./sbt +publishLocal`
for each project.

We are planning to begin publishing snapshots soon, which will make these steps
unnecessary. If you have any questions or run into any problems, please create
an issue here, tweet at us at [@finatra](https://twitter.com/finatra), or email
the [finatra-users](https://groups.google.com/forum/#!forum/finatra-users) mailing list.

## Workflow

We follow the [GitHub Flow Workflow](https://guides.github.com/introduction/flow/)

1. Fork finatra
2. Check out the `master` branch
3. Create a feature branch
4. Write code and tests for your change
6. From your branch, make a pull request against `twitter/finatra/master`
7. Work with repo maintainers to get your change reviewed
8. Wait for your change to be pulled into `twitter/finatra/master`
9. Delete your feature branch

## Testing

We've standardized on using the [ScalaTest testing framework][scalatest].
Because ScalaTest has such a big surface area, we use a restricted subset of it
in our tests to keep them easy to read. We've chosen the `Matchers` API, and we use
the [`WordSpec` mixin][wordspec]. Please mixin our [Test trait][test-trait] to get
these defaults.

Note that while you will see a [Travis CI][travis-ci] status message in your
pull request, all changes will also be tested internally at Twitter before being merged.

## Style

We generally follow the [Scala Style Guide][scala-style-guide]. When in doubt, look around the codebase and see how it's done elsewhere.

## Code Review

The Finatra repository on GitHub is kept in sync with an internal repository at
Twitter. For the most part this process should be transparent to Finatra users,
but it does have some implications for how pull requests are merged into the
codebase.

When you submit a pull request on GitHub, it will be reviewed by the
Finatra community (both inside and outside of Twitter), and once the changes are
approved, your commits will be brought into Twitter's internal system for additional
testing. Once the changes are merged internally, they will be pushed back to
GitHub with the next sync.

This process means that the pull request will not be merged in the usual way.
Instead a member of the Finatra team will post a message in the pull request
thread when your changes have made their way back to GitHub, and the pull
request will be closed (see [this pull request][pull-example] for an example). The changes
in the pull request will be collapsed into a single commit, but the authorship
metadata will be preserved.

## Documentation

We also welcome improvements to the Finatra documentation or to the existing ScalaDocs.

[pull-example]: https://github.com/twitter/finagle/pull/267
[twitter-server-repo]: https://github.com/twitter/twitter-server
[finagle-repo]: https://github.com/twitter/finagle
[util-repo]: https://github.com/twitter/util
[effectivescala]: https://twitter.github.io/effectivescala/
[wordspec]: http://doc.scalatest.org/2.2.1/#org.scalatest.WordSpec
[scalatest]: http://www.scalatest.org/
[scala-style-guide]: http://docs.scala-lang.org/style/scaladoc.html
[travis-ci]: https://travis-ci.org/twitter/finatra
[test-trait]: https://github.com/twitter/finatra/blob/master/finatra/inject/inject-core/src/test/scala/com/twitter/inject/Test.scala

### License
By contributing your code, you agree to license your contribution under the terms of the APLv2:
https://github.com/twitter/finatra/blob/master/LICENSE
25 changes: 0 additions & 25 deletions LICENSE
Original file line number Diff line number Diff line change
Expand Up @@ -175,28 +175,3 @@
of your accepting any such warranty or additional liability.

END OF TERMS AND CONDITIONS

APPENDIX: How to apply the Apache License to your work.

To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.

Copyright 2012 Twitter Inc

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
45 changes: 0 additions & 45 deletions README.markdown

This file was deleted.

45 changes: 0 additions & 45 deletions README.markdown.template

This file was deleted.

Loading

0 comments on commit 39dc6f6

Please sign in to comment.