Uploaded image for project: 'Beam'
  1. Beam
  2. BEAM-8956

Unify Contributor Docs

Details

    • Bug
    • Status: Resolved
    • P2
    • Resolution: Fixed
    • 2.18.0
    • Not applicable
    • website
    • None
    • Important

    Description

      Right now we have overlapping and sometimes contradictory docs on how to setup and build BEAM in four different places I've found:

      README.md
      CONTRIBUTING.md
      https://cwiki.apache.org/confluence/display/BEAM/Contributor+FAQ
      https://beam.apache.org/contribute/

      We should probably pick one as the source of truth and rewrite the
      other three to simply point to it. I propose putting all checkout,
      build, test, commit, and push instructions in CONTRIBUTING.md in the
      repo.

      Attachments

        Issue Links

          Activity

            People

              elharo@metalab.unc.edu elharo
              elharo@metalab.unc.edu elharo
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved:

                Time Tracking

                  Estimated:
                  Original Estimate - Not Specified
                  Not Specified
                  Remaining:
                  Remaining Estimate - 0h
                  0h
                  Logged:
                  Time Spent - 3h
                  3h