You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@shiro.apache.org by GitBox <gi...@apache.org> on 2021/02/17 19:55:51 UTC

[GitHub] [shiro-site] bdemers commented on a change in pull request #77: SHIRO-261

bdemers commented on a change in pull request #77:
URL: https://github.com/apache/shiro-site/pull/77#discussion_r577902053



##########
File path: how-to-contribute.md
##########
@@ -30,17 +44,21 @@ Document writers are usually the most wanted people so if you like to help but y
 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.
+*   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 (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.
+*   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, analysing 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

Review comment:
       It's a common pattern (and assumes that header sections are treated as titles), InfoQ actually has a cool tool to help with this 😄 
   http://www.conissaunce.com/pages/infoq-title-case.html
   




----------------------------------------------------------------
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:
users@infra.apache.org