[
https://issues.apache.org/jira/browse/BEAM-13780?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Danny McCormick updated BEAM-13780:
-----------------------------------
Fix Version/s: Not applicable
Resolution: Fixed
Status: Resolved (was: Open)
> 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
> Priority: P3
> Fix For: Not applicable
>
> Original Estimate: 10m
> Time Spent: 0.5h
> Remaining Estimate: 0h
>
> 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)
