-
Notifications
You must be signed in to change notification settings - Fork 792
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add Contributing file #105
Merged
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,116 @@ | ||
Contributing to Sprockets | ||
===================== | ||
|
||
Sprockets is work of [hundreds of contributors](https://github.com/rails/sprockets/graphs/contributors). You're encouraged to submit [pull requests](https://github.com/rails/sprockets/pulls), [propose features and discuss issues](https://github.com/rails/sprockets/issues). | ||
|
||
#### Fork the Project | ||
|
||
Fork the [project on Github](https://github.com/rails/sprockets) and check out your copy. | ||
|
||
``` | ||
git clone https://github.com/contributor/sprockets.git | ||
cd sprockets | ||
git remote add upstream https://github.com/rails/sprockets.git | ||
``` | ||
|
||
#### Create a Topic Branch | ||
|
||
Make sure your fork is up-to-date and create a topic branch for your feature or bug fix. | ||
|
||
``` | ||
git checkout master | ||
git pull upstream master | ||
git checkout -b my-feature-branch | ||
``` | ||
|
||
#### Bundle Install and Test | ||
|
||
Ensure that you can build the project and run tests. | ||
|
||
``` | ||
bundle install | ||
bundle exec rake test | ||
``` | ||
|
||
#### Write Tests | ||
|
||
Try to write a test that reproduces the problem you're trying to fix or describes a feature that you want to build. Add to [test](test). | ||
|
||
We definitely appreciate pull requests that highlight or reproduce a problem, even without a fix. | ||
|
||
#### Write Code | ||
|
||
Implement your feature or bug fix. | ||
|
||
Make sure that `bundle exec rake test` completes without errors. | ||
|
||
#### Write Documentation | ||
|
||
Document any external behavior in the [README](README.md). | ||
|
||
#### Update Changelog | ||
|
||
Add a line to [CHANGELOG](CHANGELOG.md) under *Next Release*. Make it look like every other line, including your name and link to your Github account. | ||
|
||
#### Commit Changes | ||
|
||
Make sure git knows your name and email address: | ||
|
||
``` | ||
git config --global user.name "Your Name" | ||
git config --global user.email "[email protected]" | ||
``` | ||
|
||
Writing good commit logs is important. A commit log should describe what changed and why. | ||
|
||
``` | ||
git add ... | ||
git commit | ||
``` | ||
|
||
#### Push | ||
|
||
``` | ||
git push origin my-feature-branch | ||
``` | ||
|
||
#### Make a Pull Request | ||
|
||
Go to https://github.com/contributor/sprockets and select your feature branch. Click the 'Pull Request' button and fill out the form. Pull requests are usually reviewed within a few days. | ||
|
||
#### Rebase | ||
|
||
If you've been working on a change for a while, rebase with upstream/master. | ||
|
||
``` | ||
git fetch upstream | ||
git rebase upstream/master | ||
git push origin my-feature-branch -f | ||
``` | ||
|
||
#### Update CHANGELOG Again | ||
|
||
Update the [CHANGELOG](CHANGELOG.md) with a short description of your change. A typical entry looks as follows. | ||
|
||
``` | ||
* Fix static asset mtime fallback. | ||
``` | ||
|
||
Amend your previous commit and force push the changes. | ||
|
||
``` | ||
git commit --amend | ||
git push origin my-feature-branch -f | ||
``` | ||
|
||
#### Check on Your Pull Request | ||
|
||
Go back to your pull request after a few minutes and see whether it passed muster with Travis-CI. Everything should look green, otherwise fix issues and amend your commit as described above. | ||
|
||
#### Be Patient | ||
|
||
It's likely that your change will not be merged and that the nitpicky maintainers will ask you to do more, or fix seemingly benign problems. Hang on there! | ||
|
||
#### Thank You | ||
|
||
Please do know that we really appreciate and value your time and work. We love you, really. |
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,7 @@ | ||
# Sprockets: Rack-based asset packaging | ||
|
||
[![Build Status](https://travis-ci.org/rails/sprockets.svg?branch=master)](https://travis-ci.org/rails/sprockets) | ||
|
||
Sprockets is a Ruby library for compiling and serving web assets. | ||
It features declarative dependency management for JavaScript and CSS | ||
assets, as well as a powerful preprocessor pipeline that allows you to | ||
|
@@ -20,7 +22,6 @@ Or include it in your project's `Gemfile` with Bundler: | |
gem 'sprockets', '~> 3.0' | ||
``` | ||
|
||
|
||
## Understanding the Sprockets Environment | ||
|
||
You'll need an instance of the `Sprockets::Environment` class to | ||
|
@@ -433,36 +434,16 @@ def self.call(input) | |
end | ||
``` | ||
|
||
## Contributing to Sprockets | ||
|
||
## Development | ||
|
||
### Contributing | ||
|
||
The Sprockets source code is [hosted on | ||
GitHub](https://github.com/rails/sprockets). You can check out a | ||
copy of the latest code using Git: | ||
|
||
$ git clone https://github.com/rails/sprockets | ||
Sprockets is the work of hundreds of contributors. You're encouraged to submit pull requests, propose | ||
features and discuss issues. | ||
|
||
If you've found a bug or have a question, please open an issue on the | ||
[Sprockets issue | ||
tracker](https://github.com/rails/sprockets/issues). Or, clone | ||
the Sprockets repository, write a failing test case, fix the bug and | ||
submit a pull request. | ||
See [CONTRIBUTING](CONTRIBUTING.md). | ||
|
||
### Version History | ||
|
||
Please see the [CHANGELOG](https://github.com/rails/sprockets/tree/master/CHANGELOG.md) | ||
|
||
## Build Status | ||
|
||
[![Build Status](https://travis-ci.org/rails/sprockets.svg?branch=master)](https://travis-ci.org/rails/sprockets) | ||
|
||
## License | ||
|
||
Copyright © 2014 Sam Stephenson <<[email protected]>> | ||
|
||
Copyright © 2014 Joshua Peek <<[email protected]>> | ||
|
||
Sprockets is distributed under an MIT-style license. See LICENSE for | ||
details. | ||
Sprockets is released under the [MIT License](MIT-LICENSE). | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can we keep the Copyright messages?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Same copyright messages are available in the license file itself
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Seems fine to have it in the license.