[jira] [Created] (BEAM-13780) Add a Contributing.md

["Danny McCormick (Jira)" <ji...@apache.org>]

Danny McCormick created BEAM-13780:
--------------------------------------

             Summary: Add a Contributing.md
                 Key: BEAM-13780
                 URL: https://issues.apache.org/jira/browse/BEAM-13780
             Project: Beam
          Issue Type: Improvement
          Components: beam-community
            Reporter: Danny McCormick
            Assignee: Danny McCormick


Right now, the repo doesn't have a Contributing.md, it just links to the contributing docs in the Readme (and its kinda buried) - I think it would be helpful to add that (probably just linking to the contribution guide). This would:

1) Help new contributors find the guide more quickly (extra helpful for people who don't necessarily need to read through the beam model, e.g. users, and people who are actively making their first contributions and want to reference it quickly)

2) Use GitHub's built in support to link the contribution guide when users open their first pr.

3) If we switch to issues, point to the contribution guide when/before users create their first issue as well.

 

Basically, its a low cost way to make getting started docs a little more discoverable. FWIW, it looks like there was at least some support for this here - [https://github.com/apache/beam/pull/10366#issuecomment-573992574]

 



--
This message was sent by Atlassian Jira
(v8.20.1#820001)