kotovalexarian-likes-github/heartcombo--devise
1
0
Fork 0
mirror of https://github.com/heartcombo/devise.git synced 2022-11-09 12:18:31 -05:00
Code Releases Activity

Expand CONTRIBUTING.md [ci skip].

Browse source
This commit is contained in:
Lucas Mazza 2016-07-12 21:29:02 -03:00
parent 245b1f9de0
commit e6b5f5f31a
No known key found for this signature in database
GPG key ID: C009F9A6BE4A44CB
1 changed files with 68 additions and 28 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

96
CONTRIBUTING.md
View file

@ -1,39 +1,79 @@
### Please read before contributing
# How to contribute to Devise
1) Do not post questions in the issues tracker. If you have any questions about
Devise, search the [Wiki](https://github.com/plataformatec/devise/wiki) or use
the [Mailing List](https://groups.google.com/group/plataformatec-devise) or
[Stack Overflow](http://stackoverflow.com/questions/tagged/devise).
Thanks for your interest on contributing to Devise! Here are a few general
guidelines on contributing and reporting bugs to Devise that we ask you to
take a look first. Notice that all of your interactions in the project are
expected to follow our [Code of Conduct](CODE_OF_CONDUCT.md).
2) If you find a security bug, **DO NOT** submit an issue here. Please send an
## Reporting Issues
Before reporting a new issue, please be sure that the issue wasn't already
reported or fixed by searching on GitHub through our [issues](https://github.com/plataformatec/devise/issues).
When creating a new issue, be sure to include a **title and clear description**,
as much relevant information as possible, and either a test case example or
even better a **sample Rails app that replicates the issue** - Devise has a lot
of moving parts and it's functionality can be affected by third party gems, so
we need as much context and details as possible to identify what might be broken
for you. We have a [test case template](guides/bug_report_templates/integration_test.rb)
that can be used to replicate issues with minimal setup.
Please do not attempt to translate Devise built in views. The views are meant
to be a starting point for fresh apps and not production material - eventually
all applications will require custom views where you can write your own copy and
translate it if the application requires it . For historical references, please look into closed
[Issues/Pull Requests](https://github.com/plataformatec/devise/issues?q=i18n) regarding
internationalization.
Avoid opening new issues to ask questions in our issues tracker. Please go through
the project wiki, documentation and source code first, or try to ask your question
on [Stack Overflow](http://stackoverflow.com/questions/tagged/devise).
**If you find a security bug, do not report it through GitHub. Please send an
e-mail to [opensource@plataformatec.com.br](mailto:opensource@plataformatec.com.br)
instead.
instead.**
3) If possible, replicate your issue with our
[guides/bug_report_templates/integration_test.rb](test case example), and attach
it to your issue or Pull Request - this way we have an isolated way to replicate
your issue and investigate it further.
## Sending Pull Requests
4) Otherwise, please provide a fresh new Rails application that replicates your
issue on a public GitHub repository, as some scenarios might not be possible to
replicate using the standalone test case example.
Before sending a new Pull Request, take a look on existing Pull Requests and Issues
to see if the proposed change or fix has been discussed in the past, or if the
change was already implemented but not yet released.
5) Do a small search on the issues tracker before submitting your issue to see
if it was already reported / fixed. Duplicated issues will be closed to avoid
too much noise/duplication in the issue tracker.
We expect new Pull Requests to include enough tests for new or changed behavior,
and we aim to maintain everything as most backwards compatible as possible,
reserving breaking changes to be ship in major releases when necessary - you
can wrap the new code path with a setting toggle from the `Devise` module defined
as `false` by default to require developers to opt-in for the new behavior.
6) When reporting an issue, include Rails, Devise and Warden versions. If you
are getting exceptions, please include the full backtrace.
If your Pull Request includes new or changed behavior, be sure that the changes
are beneficial to a wide range of use cases or it's an application specific change
that might not be so valuable to other applications. Some changes can be introduced
as a new `devise-something` gem instead of belonging to the main codebase.
7) Please do not attempt to translate Devise built in views. The views are meant
to be a starting point and not a final version. For historical references,
please look into closed issues/Pull regarding i18n.
When adding new settings, you can take advantage of the [`Devise::Models.config`](https://github.com/plataformatec/devise/blob/245b1f9de0b3386b7913e14b60ea24f43b77feb0/lib/devise/models.rb#L13-L50) method to add class and instance level fallbacks
to the new setting.
8) Notice that all of your interactions in the project are expected to follow
our [Code of Conduct](CODE_OF_CONDUCT.md)
We also welcome Pull Requests that improve our existing documentation (both our
`README.md` and the RDoc sections in the source code) or improve existing rough
edges in our API that might be blocking existing integrations or 3rd party gems.
That's it! The more information you give, the easier it becomes for us to track
it down and fix it. Ideally, you should provide an application that reproduces
the error or a test case to Devise's suite.
## Other ways to contribute
Thanks!
We welcome anyone that wants to contribute to Devise to triage and reply to
open issues to help troubleshoot and fix existing bugs on Devise. Here is what
you can do:
* Help ensure that existing issues follows the recommendations from the
_[Reporting Issues](#reporting-issues)_ section, providing feeback to the issue's
author on what might be missing.
* Review and update the existing content of our [Wiki](https://github.com/plataformatec/devise/wiki)
with up to date instructions and code samples - the wiki was grown with several
different tutorials and references that we can't keep track of everything, so if
there is a page that showcases an integration or customization that you are
familiar with feel free to update it as necessary.
* Review existing Pull Requests, and testing patches against real existing
applications that use Devise.
Thanks again for your interest on contributing to the project!
:heart: