|
| 1 | +[@envygeeks]: https://github.com/envygeeks |
| 2 | + |
| 3 | +# Contributing |
| 4 | + |
| 5 | +**Hi!** *Thanks for considering a contribution to this project*. Below you will find a short set of guidelines to help you with your contribution. Be it a bug report, a pull request, or even a question. Let me also let you know that you don't have to file a pull-request, or contribute "raw code" to this project. I would never ask you to do that if you do not wish to, or currently are unable to. All I ask is that you file bug reports, and be respectful of the fact that this software is provided for free, on a donation basis, and at mostly [@envygeeks] expense via time (and sometimes cash.) |
| 6 | + |
| 7 | +## Dependencies |
| 8 | + |
| 9 | +This project has an almost strict policy on dependencies. I do not do major updates (major version updates) of our current dependencies in anything but major releases, regardless of backwards compatibility. Dependencies are locked until the next major version. If there is a security reason for a major update, I ask that you file a bug with the upstream library and ask them to cut a minor release of the last release, which is proper. |
| 10 | + |
| 11 | +***If they cannot provide a security update for the latest version, I will consider adding the major version as an optional version, but not restricting it as the only acceptable starting version, but I will complain about having to do so, because that's not cool.*** |
| 12 | + |
| 13 | +### Languages |
| 14 | + |
| 15 | +When it comes to the language versions I support, if a language version becomes EOL (end-of-life) before a major release can be made, I will remove all official support for it before a major release, and update the list of supported versions inside of the testing. This is done to encourage users to keep updating quickly, rather than remaining on old, unstable, and unsupported versions of the language. |
| 16 | + |
| 17 | +#### Policies |
| 18 | + |
| 19 | +I tend to test on more than one version, and more than one back version of any given language if a major update hasn't been done in a while, and continue to support them as long as they are not end-of-life. For example, if my software starts with Ruby `2.2`, and the version is currently `2.5`, and I have no plans for a major update you can add `2.5` to the list of supported Rubies, however, the next major update will drop it to `2.4`, and `2.5`. If `2.2` becomes end-of-life, I will also drop it from the list. |
| 20 | + |
| 21 | +* **Ruby:** Latest + 1 Back |
| 22 | +* **JRuby:** Latest Release ***only*** |
| 23 | +* **Rubinius:** We do not support Rubinius at all. |
| 24 | +* **Node.js:** Latest LTS + Latest Release + 1 Back |
| 25 | +* **Go:** Latest + 1 Back |
| 26 | + |
| 27 | +***It should be noted that if I wish to have a feature of a language before I can make a major release, I may, or may not go ahead and enforce a newer version of a language in a point release (exp: 3.x) so that I can update my code and clean it up.*** |
| 28 | + |
| 29 | + |
| 30 | +## Bugs/Features |
| 31 | + |
| 32 | +***If you do not wish to (or are unable to) file a pull-request, you can file a bug report for any issue you have...*** as long as it is not a question. Issues include *random results*, *random errors*, *segfaults*, or anything of that nature. When you do, please make sure to include the system you are working from, the version of the language or compiler you are working with, and any relevant information that can be used to replicate the issue. ***Unreplicable issues will be closed.*** ***You can (and are encouraged to) ask questions if they are about something not documented, or if there is a question about an ambiguity in the documentation, this will prompt me to update the documentation to fix the problem.*** |
| 33 | + |
| 34 | +### What to not do |
| 35 | + |
| 36 | +* Ask me to put an urgency on your issue. |
| 37 | +* Be disrespectful: **I will block your comments**. |
| 38 | +* ":+1:" comments, I will lock issues; preventing further comments. |
| 39 | + * If you wish to "👍", "👎", or otherwise, please us the emoji-voting. |
| 40 | +* Ask if there are "any updates" |
| 41 | + |
| 42 | +**I do accept donations for fixing issues on a case-by-case urgency basis, as well as for creating features, if you need an issue addressed quickly. If you wish to do this you should contact [@envygeeks]. Otherwise issues are fixed based on complexity, time, and importance. All my projects get equal love, and sometimes it takes a minute to get back around.** |
| 43 | + |
| 44 | +### Policies |
| 45 | +#### Closing |
| 46 | +* **Immediately:** `wontfix`, `stale`, `not-a-bug` |
| 47 | +* **Closed on Next Release:** `close-on-next-release` |
| 48 | +* **1 Week (7 Days)**: `pending-feedback` |
| 49 | + |
| 50 | +#### Fixing |
| 51 | +* **Bugfix x.x.X:** `bug`, `blocker` |
| 52 | +* **Minor x.X.x:** `non-blocker`, `bug`, `feature` |
| 53 | +* **Immediately:** `documentation` |
| 54 | + |
| 55 | +## Pull Requests |
| 56 | +### Tests |
| 57 | + |
| 58 | +If you change a method in any way, your tests ***must*** pass, and if there is an additional surface added, then you ***must add tests***, in Ruby I generally prefer to use RSpec, you should refer to RSpec's documentation for information on how it works, in Go, I prefer to use Go's native testing. |
| 59 | + |
| 60 | +* ***Ruby:*** `rake spec` |
| 61 | +* ***Go:*** `go test -cover -v` |
| 62 | +* `script/test` |
| 63 | + |
| 64 | +### Code |
| 65 | + |
| 66 | +Code updates should follow the formatting of the given repository, formatting in Ruby is generally done via `rubocop` and is generally tied into `rake` and `rake spec`. Changes that are unrelated will be rejected and asked to be removed, regardless of your personal preference. You can always port those unrelated changes into another pull-request, unless they are arbitrary. |
| 67 | + |
| 68 | +#### Basics |
| 69 | + |
| 70 | +* Write your code in a clean and readable format. |
| 71 | +* Comment your code, at the high level, not lots of inline comments. |
| 72 | +* Stay at 80 lines if you can. |
| 73 | + |
| 74 | +##### Good |
| 75 | + |
| 76 | +```ruby |
| 77 | +# -- |
| 78 | +# @param hello [String] your greeting |
| 79 | +# Allows you to send a greeting back to the user |
| 80 | +# @raise if the given object is not a string |
| 81 | +# @return [String] the greeting |
| 82 | +# -- |
| 83 | +def greet(hello) |
| 84 | + raise ArgumentError, "needs string" unless hello.is_a?(String) |
| 85 | + alert hello, { |
| 86 | + class: ".greeting" |
| 87 | + } |
| 88 | +end |
| 89 | +``` |
| 90 | + |
| 91 | +##### Bad |
| 92 | + |
| 93 | +```ruby |
| 94 | +# -- |
| 95 | +# @param hello [String] your greeting |
| 96 | +# Allows you to send a greeting back to the user |
| 97 | +# @return [String] the greeting |
| 98 | +# -- |
| 99 | +def greet(hello) |
| 100 | + # @raise if the given object is not a string |
| 101 | + raise ArgumentError, "needs string" unless hello.is_a?(String) |
| 102 | + # Ship it to the user |
| 103 | + alert hello, { |
| 104 | + class: ".greeting" |
| 105 | + } |
| 106 | +end |
| 107 | +``` |
| 108 | + |
| 109 | +#### Commits |
| 110 | + |
| 111 | +Your pull-request should not add additional information outside of the Git-Commit. I understand this is Github, but explanitory data should remain in Git itself, not within Github (for the most part.) You should put the comment body of your pull request inside of your commit. |
| 112 | + |
| 113 | +``` |
| 114 | +Message |
| 115 | +
|
| 116 | +This pull-request solves X issue because it was really buggy. |
| 117 | +Please do not add extra `\n\n` here because Github displays it |
| 118 | +badly, so just let it flow, besides, this is what was intended for |
| 119 | +Git anyways, you only keep your message at 80c. |
| 120 | +``` |
| 121 | + |
| 122 | + |
| 123 | +### Documentation |
| 124 | + |
| 125 | +Documentation updates should follow the formatting of the given repository. You will be required to go through an approval process and even a comment processes. This process is mostly simple and should not impede a quick resolution. You should be prepared for the following: |
| 126 | + |
| 127 | +* Requests for unrelated changes to be removed. |
| 128 | +* Requests for language changes if the author feels it's ambiguous. |
| 129 | +* Requests for formatting changes. |
| 130 | +* Requests for `git squash` |
0 commit comments