Skip to content
Projects
Groups
Snippets
Help
This project
Loading...
Sign in / Register
Toggle navigation
P
paperclip
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
Collapse sidebar
Close sidebar
Activity
Graph
Charts
Create a new issue
Jobs
Commits
Issue Boards
Open sidebar
ikcrm_common
paperclip
Commits
6311a68b
Commit
6311a68b
authored
Jul 22, 2011
by
Mike Burns
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Add a document describing how to contribute.
parent
b62330a7
Hide whitespace changes
Inline
Side-by-side
Showing
2 changed files
with
40 additions
and
0 deletions
+40
-0
CONTRIBUTING.md
+38
-0
README.md
+2
-0
No files found.
CONTRIBUTING.md
0 → 100644
View file @
6311a68b
We love pull requests. Here's a quick guide:
1.
Fork the repo.
2.
Run the tests. We only take pull requests with passing tests, and it's great
to know that you have a clean slate:
`bundle && rake`
3.
Add a test for your change. Only refactoring and documentation changes
require no new tests. If you are adding functionality or fixing a bug, we need
a test!
4.
Make the test pass.
5.
Push to your fork and submit a pull request.
At this point you're waiting on us. We like to at least comment on, if not
accept, pull requests within three business days (and, typically, one business
day). We may suggest some changes or improvements or alternatives.
Some things that will increase the chance that your pull request is accepted,
taken straight from the Ruby on Rails guide:
*
Use Rails idioms and helpers
*
Include tests that fail without your code, and pass with it
*
Update the documentation, the surrounding one, examples elsewhere, guides,
whatever is affected by your contribution
Syntax:
*
Two spaces, no tabs.
*
No trailing whitespace. Blank lines should not have any space.
*
Prefer &&/|| over and/or.
*
MyClass.my_method(my_arg) not my_method( my_arg ) or my_method my_arg.
*
a = b and not a=b.
*
Follow the conventions you see used in the source already.
And in case we didn't emphasize it enough: we love tests!
README.md
View file @
6311a68b
...
...
@@ -239,6 +239,8 @@ guidelines:
It's a rare time when explicit tests aren't needed. If you have questions
about writing tests for paperclip, please ask the mailing list.
Please see CONTRIBUTING.md for details.
Credits
-------
...
...
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