Add initial version of release notes and contributor's guide

Author: jonas

CONTRIBUTING.md

@@ -0,0 +1,43 @@
+# Guide for contributors
+
+Scala Native Bindgen follows Scala Native's [contributing guidelines].
+Larger contributions should always begin by creating an issue to
+ensure that it is properly scoped.
+
+Important to note is that all contributors must have signed the [Scala CLA].
+
+ [contributing guidelines]: http://www.scala-native.org/en/latest/contrib/contributing.html
+ [Scala CLA]: https://www.lightbend.com/contribute/cla/scala
+
+## Developer Workflow
+
+Build the `scalaBindgen` tool:
+
+```sh
+mkdir target
+cd target
+cmake ..
+make
+
+# Alternatively rerun on change
+watchman-make -p '*.cpp' '*.h' --run 'make -C target'
+```
+
+In another terminal, run the test suite:
+
+```sh
+cd tests
+sbt ~test
+```
+
+## Coding Guidelines
+
+The C++ tool is built on Clang and Libtooling and should respect the conventions of
+LLVM and Clang tools. The code itself should adhere to the [LLVM Coding Standards],
+specifically:
+
+ - For code generation and error reporting use `llvm::outs()` and `llvm::errs()`.
+ - [Use `\n` instead of `std::endl`](https://llvm.org/docs/CodingStandards.html#avoid-std-endl)
+   and remember to flush when reporting errors.
+
+ [LLVM Coding Standards]: https://llvm.org/docs/CodingStandards.html

NEWS.md

@@ -0,0 +1,26 @@
+# Release notes
+
+## master
+
+Improvements:
+
+ - Save results from AST visitor in an intermediate representation. [#6], [#10]
+ - Add struct alloc helper. [mrRosset#3], [mrRosset#4]
+ - Simplify the build to link against system installed Clang libraries. [mrRosset#2]
+ - Use docker-compose to run tests against multiple LLVM versions on Travis. [#8], [#9]
+ - Migrate the test suite to Scala and sbt. [#17]
+ - Align code with LLVM Coding Standards. [#23]
+
+ [mrRosset#2]: https://github.com/mrRosset/scala-native-bindgen/pull/2
+ [mrRosset#3]: https://github.com/mrRosset/scala-native-bindgen/issues/3
+ [mrRosset#4]: https://github.com/mrRosset/scala-native-bindgen/pull/4
+ [#6]: https://github.com/kornilova-l/scala-native-bindgen/issues/6
+ [#8]: https://github.com/kornilova-l/scala-native-bindgen/pull/8
+ [#9]: https://github.com/kornilova-l/scala-native-bindgen/issues/9
+ [#10]: https://github.com/kornilova-l/scala-native-bindgen/pull/10
+ [#17]: https://github.com/kornilova-l/scala-native-bindgen/pull/17
+
+Based on work by [Marius Rosset][@mrRosset] done as part of a project at [EPFL].
+
+ [@mrRosset]: https://github.com/mrRosset
+ [EPFL]: https://www.epfl.ch/