CONTRIBUTING

Issue Guidelines
----------------

1) Issues should only be created for things that are definitely bugs.
   If you are not sure that the behavior is a bug, ask about it on
   GitHub Discussions or the rodauth Google Group.  GitHub Issues
   should not be used as a help forum.

2) If you are sure it is a bug, then post a complete description of
   the issue, the simplest possible self-contained example showing
   the problem and the full backtrace of any exception.

3) Issues are generally closed as soon as the problem is considered
   fixed.  However, discussion can still happen after the issue is
   closed, and the issue will be reopened if additional evidence is
   providing showing the issue still exists.

4) Potential security issues can be publicly reported in the same
   manner as non-security issues (e.g. on GitHub Issues).  However,
   if you would like to report them privately, you can report them
   via email to code@jeremyevans.net.

Pull Request Guidelines
-----------------------

1) Try to include tests for all new features and substantial bug
   fixes.

2) Try to include documentation for all new features.  In most cases
   this should include updates to files in the doc directory.

3) Follow the style conventions of the surrounding code.  In most
   cases, this is standard ruby style.

4) Do not submit whitespace changes with code changes.  Rodauth is not
   pedantic about trailing whitespace, so if you have an editor that
   automatically strips trailing whitespace, you may want to turn
   that feature off.
   
5) All code in pull requests is assumed to be MIT licensed.  Do not
   submit a pull request if that isn't the case.

6) Please do not submit pull requests for code that is not ready to
   be merged.  Pull requests should not be used to "start a
   conversation" about a possible code change.  If the pull
   request requires a conversation, that conversation should take
   place on GitHub Discussions or the rodauth Google Group.

7) Pull requests are generally closed as soon as it appears that the
   branch will not be merged.  However, discussion about the code can
   still happen after the pull request is closed, and the pull request
   can be reopened if additional commits to the branch or other
   changes make it likely that it will be merged.

Code of Conduct
---------------

This code of conduct applies to all of the project's "collaborative
space", which is defined as community communications channels,
including the Google Group, GitHub project, and source code repository.

1) Participants must ensure that their language and actions are free
   of personal attacks and remarks disparaging to people or groups.

2) Behaviour which can be reasonably considered harassment will not
   be tolerated.

3) Discussion should be limited to the project and related
   technologies.

You can report a violation of this code of conduct to the project
maintainer, who will take appropriate action.