tomee-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "ASF GitHub Bot (JIRA)" <j...@apache.org>
Subject [jira] [Commented] (TOMEE-2361) Improve main README file
Date Fri, 21 Dec 2018 02:36:00 GMT

    [ https://issues.apache.org/jira/browse/TOMEE-2361?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16726392#comment-16726392
] 

ASF GitHub Bot commented on TOMEE-2361:
---------------------------------------

GitHub user cesarhernandezgt opened a pull request:

    https://github.com/apache/tomee/pull/299

    TOMEE-2361 Improve main README file (WIP)

    

You can merge this pull request into a Git repository by running:

    $ git pull https://github.com/cesarhernandezgt/tomee TOMEE-2361

Alternatively you can review and apply these changes as the patch at:

    https://github.com/apache/tomee/pull/299.patch

To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:

    This closes #299
    
----
commit 4c268b30b2de1ee8f69a19f0a9168efb8844e94b
Author: CesarHernandezGt <cfhernan123@...>
Date:   2018-12-21T02:34:51Z

    TOMEE-2361 Initial work

----


> Improve main README file
> ------------------------
>
>                 Key: TOMEE-2361
>                 URL: https://issues.apache.org/jira/browse/TOMEE-2361
>             Project: TomEE
>          Issue Type: Improvement
>          Components: Examples and Documentation
>    Affects Versions: 8.0.0-M1
>            Reporter: Roberto Cortez
>            Assignee: Cesar Hernandez
>            Priority: Major
>              Labels: pull-request-available
>             Fix For: 8.0.0-M2
>
>
> Right now, our main readme file is very poor:
>  [https://github.com/apache/tomee/blob/master/README.md]
> I think we should improve it a bit by adding the following information:
>  * Project description
>  * Downloads
>  * Contribution guidelines
>  * Links to docs with examples or other relevant information
>  * Links to tools used by the project
>  * Any other relevant stuff
> This may look like a duplication from the website. We can and should link to pieces of
information there. On the other hand, people may find the project directly on Github and should
have a minimal piece of information to get them started.



--
This message was sent by Atlassian JIRA
(v7.6.3#76005)

Mime
View raw message