Uploaded image for project: 'CiviCRM'
  1. CiviCRM
  2. CRM-21566

Better documentation of Contributions

    Details

    • Type: Improvement
    • Status: Open
    • Priority: Trivial
    • Resolution: Unresolved
    • Affects Version/s: 4.7.28
    • Fix Version/s: None
    • Component/s: WordPress Integration
    • Labels:
      None
    • Versioning Impact:
      Patch (backwards-compatible bug fixes)
    • Documentation Required?:
      User and Admin Doc
    • Funding Source:
      Needs Funding
    • Verified?:
      No

      Description

      There should be better documentation of how to contribute to the codebase - at the moment the GitHub repo mentions the branches we should use, but doesn't mention whether we should do PR's fork it into our own namespace etc., and also that we should have a JIRA ticket for the work as well.

      The JIRA ticket requirement is also quite an annoyance, as there is no way to create a ticket without having an account - which in itself is not a bad thing, as I understand the repercussions of having an open issue point, but then the creation of a full CiviCRM account which requires administrator access means that the barrier to entry is much higher. I wonder if there is something that could be done for this which would mean that there is a lower barrier to entry for contributing, for less technically adept people?

      There are probably also some other things which are needed for contributing code that I have missed, but all of this is due to personal experience, as it took a fair amount of time to get to the final stage of full sign off.

      Also note that I know exactly how hard it is to get people to help with projects, and that having the barrier for entry as low as possible means everyone wins from more users and contributors!

        Attachments

          Activity

            People

            • Assignee:
              Unassigned
              Reporter:
              TBSliver Thomas Bloor
            • Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

              Dates

              • Created:
                Updated: