Uploaded image for project: 'Fedora Repository Project'
  1. Fedora Repository Project
  2. FCREPO-1584

Extend Guidelines for Testing (Using {code} Macro Examples)

    Details

    • Type: Documentation
    • Status: Closed
    • Priority: Minor
    • Resolution: Fixed
    • Affects Version/s: Fedora 4.2.0
    • Fix Version/s: Fedora 4.3.0
    • Component/s: None
    • Labels:
    • Roadmap Theme:
      Documentation
    • Sprint:
      Sprint 2015 - 7, Sprint 2015 - 8

      Description

      Within the page https://wiki.duraspace.org/display/FF/Guide+for+New+Developers it would perhaps be desirable to integrate examples from the code base when referencing the design patterns and frameworks utilized for testing.

      Further, it could also be of some value to reference methodological aims regarding the practice of test-driven development (in a manner such that potential contributors are encouraged to maintain or increase the quality of the code base).

        Attachments

          Activity

          Hide
          awoods Andrew Woods added a comment -

          James R. Griffin III, I added the "Git For Confluence" plugin. See the following update (duplicate file currently displayed), and see what you think:
          https://wiki.duraspace.org/pages/diffpagesbyversion.action?pageId=34655501&selectedPageVersions=10&selectedPageVersions=11

          The obvious downside is that there does not appear to be a way to select a portion of a file.

          Show
          awoods Andrew Woods added a comment - James R. Griffin III , I added the "Git For Confluence" plugin. See the following update (duplicate file currently displayed), and see what you think: https://wiki.duraspace.org/pages/diffpagesbyversion.action?pageId=34655501&selectedPageVersions=10&selectedPageVersions=11 The obvious downside is that there does not appear to be a way to select a portion of a file.
          Hide
          jrgriffiniii James R. Griffin III added a comment -

          Andrew Woods thank you very much for this. I believe that this is indeed quite an improvement, and appears to address the concerns voiced by A. Soroka:

          [...]
          I'm a little troubled by the burden of keeping any more than one source code resource up to date. It's not something we never do, but it would be better to "import" or "quote" code from the actual codebase. It would keep us honest, too.

          Unfortunately, attempting to set the "firstline" property of the macro setting does, as you indicated, fail to select a portion of the file being integrated into the Page.

          However, given that the examples are structured within "expand" macro blocks, I believe that these shortcoming does not offset the advantages present in ensuring that the documentation does not fall out of parity with the code base itself.

          Show
          jrgriffiniii James R. Griffin III added a comment - Andrew Woods thank you very much for this. I believe that this is indeed quite an improvement, and appears to address the concerns voiced by A. Soroka : [...] I'm a little troubled by the burden of keeping any more than one source code resource up to date. It's not something we never do, but it would be better to "import" or "quote" code from the actual codebase. It would keep us honest, too. Unfortunately, attempting to set the "firstline" property of the macro setting does, as you indicated, fail to select a portion of the file being integrated into the Page. However, given that the examples are structured within "expand" macro blocks, I believe that these shortcoming does not offset the advantages present in ensuring that the documentation does not fall out of parity with the code base itself.
          Hide
          awoods Andrew Woods added a comment -

          James R. Griffin III, thanks. Please finish updating the wiki page(s) with this macro, then click the button "Start Review" on this ticket when you are done. If you do not see such a button, please let me know.

          Show
          awoods Andrew Woods added a comment - James R. Griffin III , thanks. Please finish updating the wiki page(s) with this macro, then click the button "Start Review" on this ticket when you are done. If you do not see such a button, please let me know.
          Hide
          jrgriffiniii James R. Griffin III added a comment -

          Andrew Woods thank you for your patience, the Page has been updated. Unfortunately, I do not believe that the "Start Review" button is accessible for me (I attempted this while the Issue was in progress, after I've stopped the progress for the issue, and after I've refreshed the page in browser clients).

          Show
          jrgriffiniii James R. Griffin III added a comment - Andrew Woods thank you for your patience, the Page has been updated. Unfortunately, I do not believe that the "Start Review" button is accessible for me (I attempted this while the Issue was in progress, after I've stopped the progress for the issue, and after I've refreshed the page in browser clients).
          Show
          awoods Andrew Woods added a comment - Resolved with: https://wiki.duraspace.org/pages/diffpagesbyversion.action?pageId=34655501&selectedPageVersions=12&selectedPageVersions=7

            People

            • Assignee:
              jrgriffiniii James R. Griffin III
              Reporter:
              jrgriffiniii James R. Griffin III
            • Votes:
              0 Vote for this issue
              Watchers:
              3 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved:

                Time Tracking

                Estimated:
                Original Estimate - Not Specified
                Not Specified
                Remaining:
                Remaining Estimate - 0 minutes
                0m
                Logged:
                Time Spent - 41 minutes
                41m