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/05/27 16:32:28 UTC

[GitHub] [shiro-site] pitjazz commented on a change in pull request #77: [SHIRO-261] - Improvements to how-to-contribute guide

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



##########
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!

Review comment:
       Fixed this.
   
   But... The real link is missing approx from twenty *.md files from shiro-site project. Only mailing.lists.html is used on those files instead of the real link. FYI @bmarwell .




-- 
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