diff options
| -rw-r--r-- | CONTRIBUTING.md | 13 | ||||
| -rw-r--r-- | README.md | 19 |
2 files changed, 22 insertions, 10 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 28ef27f42..5c2eaec5e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -48,6 +48,12 @@ Please include a nice description of your changes with your PR; if we have to read the whole diff to figure out why you're contributing in the first place, you're less likely to get feedback and have your change merged in. +If you are working on a particular area then feel free to submit a PR that +highlights your work in progress (and flag in the PR title that it's not +ready to merge). This will help in getting visibility for your fix, allow +others to comment early on the changes and also let others know that you +are currently working on something. + ## Porting Code From Other Open-Source Projects `libgit2` is licensed under the terms of the GPL v2 with a linking @@ -57,14 +63,17 @@ The most common case is porting code from core Git. Git is a pure GPL project, which means that in order to port code to this project, we need the explicit permission of the author. Check the [`git.git-authors`](https://github.com/libgit2/libgit2/blob/development/git.git-authors) -file for authors who have already consented; feel free to add someone if -you've obtained their consent. +file for authors who have already consented. Other licenses have other requirements; check the license of the library you're porting code *from* to see what you need to do. As a general rule, MIT and BSD (3-clause) licenses are typically no problem. Apache 2.0 license typically doesn't work due to GPL incompatibility. +If you are pulling in code from core Git, another project or code you've pulled from +a forum / Stack Overflow then please flag this in your PR and also make sure you've +given proper credit to the original author in the code snippet. + ## Style Guide `libgit2` is written in [ANSI C](http://en.wikipedia.org/wiki/ANSI_C) @@ -11,20 +11,23 @@ libgit2 is licensed under a **very permissive license** (GPLv2 with a special Li This basically means that you can link it (unmodified) with any kind of software without having to release its source code. -* Mailing list: ~~<libgit2@librelist.org>~~ - The libgit2 mailing list has - traditionally been hosted in Librelist, but Librelist is and has always - been a shitshow. We encourage you to [open an issue](https://github.com/libgit2/libgit2/issues) - on GitHub instead for any questions regarding the library. - * Archives: <http://librelist.com/browser/libgit2/> * Website: <http://libgit2.github.com> +* StackOverflow Tag: [libgit2](http://stackoverflow.com/questions/tagged/libgit2) +* Issues: <https://github.com/libgit2/libgit2/issues> * API documentation: <http://libgit2.github.com/libgit2> * IRC: #libgit2 on irc.freenode.net. +* Mailing list: The libgit2 mailing list was + traditionally hosted in Librelist but has been deprecated. We encourage you to + [use StackOverflow](http://stackoverflow.com/questions/tagged/libgit2) or [open an issue](https://github.com/libgit2/libgit2/issues) + on GitHub instead for any questions regarding the library. The mailing list archives are still available at + <http://librelist.com/browser/libgit2/>. + What It Can Do ================================== -libgit2 is already very usable. +libgit2 is already very usable and is being used in production for many applications including the GitHub.com site, in Plastic SCM +and also powering Microsoft's Visual Studio tools for Git. The library provides: * SHA conversions, formatting and shortening * abstracted ODB backend system @@ -128,8 +131,8 @@ Here are the bindings to libgit2 that are currently available: * Lua * luagit2 <https://github.com/libgit2/luagit2> * .NET - * libgit2net, low level bindings <https://github.com/txdv/libgit2net> * libgit2sharp <https://github.com/libgit2/libgit2sharp> + * libgit2net, low level bindings superceeded by libgit2sharp <https://github.com/txdv/libgit2net> * Node.js * node-gitteh <https://github.com/libgit2/node-gitteh> * nodegit <https://github.com/tbranyen/nodegit> |