-
Notifications
You must be signed in to change notification settings - Fork 7
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Jeremy Brown
committed
Oct 9, 2014
1 parent
a35eadd
commit ff36267
Showing
2 changed files
with
136 additions
and
0 deletions.
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,5 @@ | ||
# sl-model Changelog | ||
|
||
### 1.0.0 | ||
|
||
* Initial release |
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,131 @@ | ||
# Getting Involved | ||
|
||
There are many ways to contribute to the project, including fixing issues or improving documentation. | ||
|
||
# Questions | ||
|
||
This is the issue tracker for `sl-model`. The community uses this site to collect and track bugs and discussions of | ||
new features. If you are having difficulties using `sl-model` or have a question about usage please ask a question | ||
on Stack Overflow: http://stackoverflow.com/questions/ask?tags=sl-model | ||
|
||
# Issues | ||
|
||
Think you've found a bug or have a new feature to suggest? Let us know! | ||
|
||
## Reporting a Bug | ||
|
||
1. Update to the most recent master release if possible. We may have already fixed your bug. | ||
|
||
2. Search for similar issues. It's possible somebody has encountered this bug already. | ||
|
||
3. Provide a demo that specifically shows the problem. This demo should be fully operational with the exception of the | ||
bug you want to demonstrate. The more pared down, the better. Issues with demos are prioritized. | ||
|
||
4. Your issue will be verified. The provided demo will be tested for correctness. The sl-model team will work with | ||
you until your issue can be verified. | ||
|
||
5. Keep up to date with feedback from the sl-model team on your ticket. Your ticket may be closed if it becomes | ||
stale. | ||
|
||
6. If possible, submit a Pull Request with a failing test. Better yet, take | ||
a stab at fixing the bug yourself if you can! | ||
|
||
The more information you provide, the easier it is for us to validate that | ||
there is a bug and the faster we'll be able to take action. | ||
|
||
## Requesting a Feature | ||
|
||
1. Search Issues for similar feature requests. It's possible somebody has already asked | ||
for this feature or provided a pull request that we're still discussing. | ||
|
||
2. Provide a clear and detailed explanation of the feature you want and why it's important to add. Keep in mind that we | ||
want features that will be useful to the majority of our users and not just a small subset. If you're just targeting a | ||
minority of users, consider writing your own addon library for `ember-cli` that extends this one. | ||
|
||
3. If the feature is complex, consider writing some initial documentation for it. If we do end up accepting the feature | ||
it will need to be documented and this will also help us to understand it better ourselves. | ||
|
||
4. Attempt a Pull Request. If you are willing to help the project out, you can submit a Pull Request. We always have | ||
more work to do than time to do it. If you can write some code then that will speed the process along. | ||
|
||
# Pull Requests | ||
|
||
## Contributer License Agreement | ||
Contributions to the sl-model project require the submission of a contributer license agreement. Individual | ||
contributers should review and complete the [Individual CLA](CLA-INDIVIDUAL.md). Contributions made on behalf of a | ||
company/employer will necessitate the completion of the [Corporate CLA](CLA-CORPORATE.md). | ||
|
||
If you have any questions about either of these documents please contact the same individual listed in the documents | ||
you are to send your completed copies to. | ||
|
||
## 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: | ||
`npm install && bower install && ember test`. | ||
|
||
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. Commit your changes. If your pull request fixes an issue specify it in the commit message. Here's an example: | ||
`git commit -m "Close #12 Fix passing of context"` | ||
|
||
6. Push to your fork and submit a pull request. Please provide us with some explanation of why you made the changes you | ||
made. For new features make sure to explain a standard use case to us. | ||
|
||
7. Update the Changelog. Please prefix your change with one of the following tags inside brackets: BUGFIX, | ||
FEATURE/ENHANCEMENT, INTERNAL. If a change requires a user to change their configuration, `bower.json`, `package.json`, | ||
or `Brocfile.js` also add a BREAKING tag within the brackets before any other tags (example [BREAKING BUGFIX]). | ||
|
||
- FEATURE and ENHANCEMENT tags are for things that users are interested in. Avoid super technical talk. Craft a | ||
concise description of the change. | ||
- BUGFIX tag is a link to a bug + a link to a patch. | ||
- INTERNAL tag is an internal log of changes. | ||
|
||
We try to be quick about responding to tickets but sometimes we get a bit backlogged. If the response is slow, try to | ||
find someone on IRC(#softlayer) to give the ticket a review. | ||
|
||
Some things that will increase the chance that your pull request is accepted, taken straight from the Ruby on Rails | ||
guide: | ||
|
||
* Use Node 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 #### | ||
|
||
* Four spaces, no tabs. | ||
* No trailing whitespace. Blank lines should not have any space. | ||
* Follow the conventions you see used in the source already. | ||
|
||
#### Inline Documentation Guidelines #### | ||
|
||
All inline documentation is written using [JSDoc](http://usejsdoc.org/). Follow these rules when updating or writing | ||
new documentation: | ||
|
||
1. All code blocks must be fenced. | ||
3. All code blocks must be valid code for syntax highlighting. | ||
4. All examples in code blocks must be aligned. | ||
5. Use two spaces between the code and the example: `foo(); // result`. | ||
6. All references to code words must be enclosed in backticks. | ||
7. Prefer a single space between sentences. | ||
8. Wrap long markdown blocks > 120 characters. | ||
9. Don't include blank lines after `@param` definitions. | ||
|
||
|
||
#### Code Words #### | ||
|
||
* `thisPropertyName` | ||
* `Global.Class.attribute` | ||
* `thisFunction()` | ||
* `Global.CONSTANT_NAME` | ||
* `true`, `false`, `null`, `undefined` (when referring to programming values) | ||
|
||
And in case we didn't emphasize it enough: **we love tests!** | ||
|
||
NOTE: Partially copied from https://raw.githubusercontent.com/stefanpenner/ember-cli/master/CONTRIBUTING.md |