bdemers commented on a change in pull request #77: URL: https://github.com/apache/shiro-site/pull/77#discussion_r615091838
########## File path: how-to-contribute.md ########## @@ -1,177 +1,198 @@ <a name="HowtoContribute-ContributingtoApacheShiro"></a> -#Contributing to Apache Shiro - -* [Introduction](#HowtoContribute-introduction) -* [Help Wanted Here](#HowtoContribute-help) -* [Procedure for reporting bugs and issues and enhancement suggestions](#HowtoContribute-procedure) -* [Git Usage](#HowtoContribute-git) -* [Git Committers](#HowtoContribute-committer) -* [Procedure for Raising Development Issues](#HowtoContribute-issues) -* [How to prepare and contribute patches](#HowtoContribute-patches) -* [How to revert changes in Git](#HowtoContribute-revert) -* [Contribution Notes and Tips](#HowtoContribute-tips) +# Contributing to Apache Shiro + +* [Introduction](#HowtoContribute-introduction) +* [Help Wanted Here](#HowtoContribute-help) +* [Procedure for Raising Development Issues](#HowtoContribute-issues) +* [Procedure for Reporting Bugs and Issues and Enhancement uggestions](#HowtoContribute-procedure) +* [Git Usage](#HowtoContribute-git) +* [Git Committers](#HowtoContribute-committer) +* [Contribution Notes and Tips](#HowtoContribute-tips) <a name="HowtoContribute-introductions"></a> <a name="HowtoContribute-Introduction"></a> -##Introduction +## Introduction + +Apache Shiro is an [Open Source](https://opensource.org/) software security framework that performs authentication, authorization, cryptography and session management. The Shiro Project is an volunteer project released under a [liberal license](license.html "License"). Anyone can participate and volunteer. No need to be an experienced developer or have great visions. Roll up your sleeves and come try, help is always welcome, and your input will be appreciated! -The Shiro Project is an [Open Source](https://opensource.org/) volunteer project released under a [very liberal license](license.html "License"). This means there are many ways to contribute to the project - either with direct participation (coding, documenting, answering questions, proposing ideas, reporting bugs, suggesting bug-fixes, etc..) or by resource donations (staff time, conference presentations, publicity, software) and even general hardware/money [donations](http://www.apache.org/foundation/thanks.html) via the [Apache Software Foundation](http://www.apache.org). +There are many ways how to contribute to this project, you can participate directly by: +* coding +* documenting +* answering questions +* proposing ideas +* reporting bugs +* suggesting bug-fixes +* etc. -To begin with, we suggest you to subscribe to the [Shiro mailing lists](mailing-lists.html "Mailing Lists") (follow the link for information on how to subscribe and to access the mail list archives). Listen-in for a while, to hear how others make contributions. +Or you can participate with resource donations: +* staff time +* conference presentations +* publicity +* software +* general hardware/money [donations](http://www.apache.org/foundation/thanks.html) via the [Apache Software Foundation](http://www.apache.org) -You can get your local working copy of the [latest and greatest code](download.html "Download") by following the directions in our [Download](download.html "Download") page. Review the To Do list in the [issue tracker](https://issues.apache.org/jira/browse/SHIRO) and then choose a task that interests you. Perhaps you have noticed something that needs patching, or have a new feature to contribute. Make the changes, do the testing, generate a patch, and discuss on the [dev mailing list](mailing-lists.html "Mailing Lists"). (Do not worry - the process is easy and explained below.) +You can get your local working copy of the [latest and greatest code](download.html "Download") by following the directions in [Download](download.html "Download") page. Review the To Do list in the [issue tracker](https://issues.apache.org/Jira/browse/SHIRO) and then choose a task that interests you. -Document writers are usually the most wanted people so if you like to help but you're not familiar with the innermost technical details, don't worry: you can still be tremendously helpful! +Perhaps you have noticed something that needs patching or have a new feature to contribute. Make the changes, do the testing, generate a patch, and discuss on the [dev mailing list](mailing-lists.html "Mailing Lists"). The process is easy and explained below. Subscribe to the mailing list! <a name="HowtoContribute-help"></a> <a name="HowtoContribute-HelpWantedHere"></a> -##Help Wanted Here +## Help Wanted Here You can be a huge help by providing extra assistance in any of the following areas: -* Assisting to improve documentation and the website. -* Testing Shiro (especially its less-frequently-used features) on various configurations and reporting back. -* New samples for the 'shiro-sample' to concisely describe and demonstrate features. Such samples can also enable automated testing. -* Debugging - producing reproducible test cases and/or finding causes of bugs. Most bugs are recorded as issues (see [explanation below](#HowtoContribute-procedure)). -* Providing new use-cases and requirements. If you think that Shiro does not quite meet your needs then tell us about it on the mailing list. -* Specifying/analysing/designing new features - and beyond. If you wish to get further involved with this, please join the [`shiro-dev` mailing list](mailing-lists.html "Mailing Lists"), install and try out Shiro and read some of the [mail archives](mailing-lists.html "Mailing Lists"). You should have a reasonable fluency in security technologies, some Java and Maven skills, and a basic understanding of the Shiro architecture - don't just say "it should have XYZ" without reading anything first - because chances are, somebody has already thought of that feature!) -* Packaging easy-to-install packages (such as RPMs) for the myriad of possible configurations out there. (The project does not maintain anything but the basic .zip and .tar.gz packages, but anyone is welcome to build their own specific packages and announce them on the forrest-dev list) -* ... and there is just one other thing - don't forget to tell everyone who asks, how great Shiro is! The more people that know about and start to use Shiro, the larger the pool of potential contributors will be. +* Assisting to improve documentation and the website. +* Testing Shiro on various configurations and reporting back, especially Shiro's less-frequently-used features. +* New samples for the 'shiro-sample' to concisely describe and demonstrate features. Such samples can also enable automated testing. +* Debugging - producing reproducible test cases and/or finding causes of bugs. Most bugs are [recorded as issues](#HowtoContribute-procedure)). +* Providing new use-cases and requirements. +** If you think that Shiro does not quite meet your needs then tell us about it on the mailing list. +* Specifying, analyzing or designing new features - and beyond. +** If you wish to get further involved with this, please join the [`shiro-dev` mailing list](mailing-lists.html "Mailing Lists"), install and try out Shiro and read some of the [mail archives](mailing-lists.html "Mailing Lists"). +*** Don't just say "it should have XYZ" without reading anything first - because chances are, somebody has already thought of that feature. +* Packaging easy-to-install packages (such as Red Hat Package Managers (RPM)) for the myriad of possible configurations out there. +** The project does not maintain anything but the basic .zip and .tar.gz packages, but anyone is welcome to build their own specific packages and announce those on the mailing list. +* ... and one more thing - don't forget to tell everyone, how great Shiro is! The more people that know about and start to use Shiro, the larger the pool of potential contributors will be. <a name="HowtoContribute-procedure"></a> <a name="HowtoContribute-Procedureforreportingbugsandissuesandenhancementsuggestions"></a> -##Procedure for reporting bugs and issues and enhancement suggestions +## Procedure for Reporting Bugs and Issues and Enhancement Suggestions -If you think that you have found a bug or you have a suggestion for improvement, then please discuss it on one of the [mailing lists](mailing-lists.html "Mailing Lists"). However, please check our [issue tracker](https://issues.apache.org/jira/browse/SHIRO) first as it may be already reported. +If you think that you have found a bug or you have a suggestion for improvement, then please discuss it on one of the [mailing lists](mailing-lists.html "Mailing Lists"). However, please check our [issue tracker](https://issues.apache.org/Jira/browse/SHIRO) first as it may be already reported. -The [Apache Shiro Issue Tracker](https://issues.apache.org/jira/browse/SHIRO) collates our known issues. Obviously not every issue is listed there. Some issues have been discussed on the mailing list but do not yet have an issue recorded. +The [Apache Shiro Issue Tracker](https://issues.apache.org/Jira/browse/SHIRO) collates our known issues. Obviously not every issue is listed there. Some issues have been discussed on the mailing list but do not yet have an issue recorded. Review comment: ```suggestion The [Apache Shiro Issue Tracker](https://issues.apache.org/jira/browse/SHIRO) collates our known issues. Obviously, not every issue is listed there. Some issues have been discussed on the mailing list but do not yet have an issue recorded. ``` -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: [email protected]
