Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 110 lines (78 sloc) 3.685 kb
92685ae1 »
2012-12-30 adds a contributing file [Issue 3]
1 suggestions and patches welcome! Thank you in advance.
2
3 # THANK YOU
4
5 Big thanks to all current and future contributors. Mad Props to JT Smith for writing Facebook::Graph and spelunking the byzantine documentation of facebook's graph api.
6
7 ## Helpers:
8 * Tommy Stanton: pod docs! yaml clean-up, dzil cleanup, testing, and
9 moral support.
10
11 # Building from Source
12
13 ## Checking out sources
14
15 ````
16 # clone from github:
17 git clone https://github.com/spazm/p5-facebook-graph-cmdline.git
18 ````
19
20 ## Installing Author Dependencies
21 ````
22 # install cpanm
23 cpan App::cpanminus
24
25 # install Dist::Zilla
26 cpanm install Dist::Zilla
27
28 # change to the root of the project check out
29 cd p5-facebook-graph-cmdline
30
31 #install author dependencies with cpanm (App::cpanminus)
32 dzil authordeps | cpanm
33 ````
34
35 ## Running tests
36 ````
37 # build and test:
38 dzil test
39 # just build
40 dzil build
41 ````
42
43 # Contributing
44
45 ## Issue Requests and Bug Tracking
46 Please file tickets using the github ticketing system:
47
b5d71e5d »
2012-12-30 fixup: clean up CONTRIBUTING markdown
48 [Github issues](https://github.com/spazm/p5-facebook-graph-cmdline/issues)
92685ae1 »
2012-12-30 adds a contributing file [Issue 3]
49
50 ## Patches
51
52 Patches of any form may be accepted, they may be edited. You may email me first or just jump straight to patching.
53
54 I prefer code with:
b5d71e5d »
2012-12-30 fixup: clean up CONTRIBUTING markdown
55
56 * tests
57 * examples
58 * concise testable functions
59 * descriptive commit messages
92685ae1 »
2012-12-30 adds a contributing file [Issue 3]
60
61 ## Making Changes
b5d71e5d »
2012-12-30 fixup: clean up CONTRIBUTING markdown
62 ([borrowed](https://github.com/puppetlabs/puppet/blob/master/CONTRIBUTING.md) from the puppet docs)
92685ae1 »
2012-12-30 adds a contributing file [Issue 3]
63
64 * Create a topic branch from where you want to base your work.
65 * This is usually the master branch.
66 * Only target release branches if you are certain your fix must be on that
67 branch.
68 * To quickly create a topic branch based on master; `git branch
69 fix/master/my_contribution masterbranch.
70 * Make commits of logical units.
71 * Check for unnecessary whitespace with `git diff --check` before committing.
b5d71e5d »
2012-12-30 fixup: clean up CONTRIBUTING markdown
72 * Make sure your commit messages are in proper format:
92685ae1 »
2012-12-30 adds a contributing file [Issue 3]
73 ````
74 (#99999) Make the example in CONTRIBUTING imperative and concrete
75
76 Without this patch applied the example commit message in the CONTRIBUTING
77 document is not a concrete example. This is a problem because the
78 contributor is left to imagine what the commit message should look like
79 based on a description rather than an example. This patch fixes the
80 problem by making the example concrete and imperative.
81
82 The first line is a real life imperative statement with a ticket number
83 from our issue tracker. The body describes the behavior without the patch,
84 why this is a problem, and how the patch fixes the problem when applied.
85 ````
86 * Make sure you have added the necessary tests for your changes.
87 * Run _all_ the tests to assure nothing else was accidentally broken.
88
89 ## Submitting Changes
90
b5d71e5d »
2012-12-30 fixup: clean up CONTRIBUTING markdown
91 * Push your changes to a topic branch in your fork of the repository
92685ae1 »
2012-12-30 adds a contributing file [Issue 3]
92 * Submit a pull request to my repository
93
94 ### github pull requests
95
96 github pull requests are preferred as they are easiest to integrate. Make a github clone of the project, commit your changes and then file a pull request via the github UI.
97
98 ### patches
b5d71e5d »
2012-12-30 fixup: clean up CONTRIBUTING markdown
99 Git can create patches from your local repository. Use `git-format-patch` to create the patch and mail it to `spazm` _at_ `cpan.org`.
92685ae1 »
2012-12-30 adds a contributing file [Issue 3]
100
101 If you're not comfortable with git, mail a unified patch produced by `diff -u`. Or ask me your git questions, I'm happy to help get you started.
102
103 Caveat, I get a lot of spam to my cpan address, so I may not see your patch for a while. Filing a bug request on github will help.
104
105 # Additional Resources
106 * [General GitHub documentation](http://help.github.com/)
107 * [GitHub pull request documentation](http://help.github.com/send-pull-requests/)
108
109 Thanks again!
Something went wrong with that request. Please try again.