Skip to content
Projects
Groups
Snippets
Help
This project
Loading...
Sign in / Register
Toggle navigation
G
git2
Overview
Overview
Details
Activity
Cycle Analytics
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Charts
Issues
0
Issues
0
List
Board
Labels
Milestones
Merge Requests
0
Merge Requests
0
CI / CD
CI / CD
Pipelines
Jobs
Schedules
Charts
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Charts
Create a new issue
Jobs
Commits
Issue Boards
Open sidebar
lvzhengyang
git2
Commits
41b00ccc
Commit
41b00ccc
authored
Nov 20, 2012
by
Ben Straub
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Add contributing guidelines
parent
560cc1e1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
47 additions
and
0 deletions
+47
-0
CONTRIBUTING.md
+47
-0
No files found.
CONTRIBUTING.md
0 → 100644
View file @
41b00ccc
# Welcome to libgit2!
We're making it easy to do interesting things with git, and we'd love to have
your help.
## Discussion & Chat
We hang out in the #libgit2 channel on irc.freenode.net.
## Reporting Bugs
First, know which version of libgit2 your problem is in. Compile and test
against the
`development`
branch to avoid re-reporting an issue that's already
been fixed.
It's
*incredibly*
helpful to be able to reproduce the problem. Please include
a bit of code and/or a zipped repository (if possible). Note that some of the
developers are employees of GitHub, so if your repository is private, find us
on IRC and we'll figure out a way to help you.
## Pull Requests
Life will be a lot easier for you if you create a named branch for your
contribution, rather than just using your fork's
`development`
.
It's helpful if you include a nice description of your change with your PR; if
someone has 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.
## Porting Code From Other Open-Source Projects
The most common case here is porting code from core Git. Git is a 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.
Other licenses have other requirements; check the license of the library you're
porting code
*from*
to see what you need to do.
## Styleguide
We like to keep the source code consistent and easy to read. Maintaining this
takes some discipline, but it's been more than worth it. Take a look at the
[
conventions file
](
https://github.com/libgit2/libgit2/blob/development/CONVENTIONS
)
.
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment