metron-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Elana Hashman (JIRA)" <j...@apache.org>
Subject [jira] [Created] (METRON-13) Add a new contributor document
Date Wed, 06 Jan 2016 23:42:39 GMT
Elana Hashman created METRON-13:
-----------------------------------

             Summary: Add a new contributor document
                 Key: METRON-13
                 URL: https://issues.apache.org/jira/browse/METRON-13
             Project: Metron
          Issue Type: New Feature
            Reporter: Elana Hashman
            Priority: Minor


When I visit the project on GitHub, I find there is no `CONTRIBUTING.md` file or similar available
for new contributors. Such a file should contain:

- Where to find issues (i.e. a link to the JIRA)
- Where to find more information about the project (neither the official project website nor
documentation are provided links in the README)
- How to build the code (covered by METRON-7)
- Contact info for the team (IRC channel? mailing lists?)

Some other things that would be nice to include...

- How to pick issues to work on as a new contributor
- A style guide for contributions
- What the code review process looks like



--
This message was sent by Atlassian JIRA
(v6.3.4#6332)

Mime
View raw message