Uploaded image for project: 'CFEngine Community'
  1. CFEngine Community
  2. CFE-2998

Review and update descriptions of libs in CONTRIBUTING.md

    XMLWordPrintable

    Details

    • Type: Task
    • Status: Done
    • Priority: Medium
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: N/A
    • Component/s: None
    • Labels:
      None

      Description

      CONTRIBUTING.md has an explanation of what most libraries in cfengine/core are for. We should make sure this is up to date and aligned with the current development teams views.

      As an example, I would like to add some global definitions to libutils, instead of libpromises. They are used heavily in various "utility" functions, and don't contain global state, just defaults etc. Examples are WORKDIR, CF_BUFSIZE, etc. CONTRIBUTING.md should explicitly state what should be in libutils, and why.

        Attachments

          Activity

            People

            • Assignee:
              karlhto Karl Hole Totland
              Reporter:
              olehermanse Ole Herman Schumacher Elgesem
            • Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved:

                Summary Panel