sdf_tutorials icon indicating copy to clipboard operation
sdf_tutorials copied to clipboard

Need to add a README with cross-references, scope, etc.

Open EricCousineau-TRI opened this issue 5 years ago • 4 comments

No README currently. The new readme should have something like:

  • A pointer to sdformat.org
  • A pointer to the sdformat repository
  • Development tips
    • How to preview branches
    • Contribution guidelines?
      • https://ignitionrobotics.org/docs/all/contributing (currently still catered towards BitBucket)
      • https://index.ros.org/doc/ros2/Contributing/Developer-Guide/#pull-requests
  • [x] For previewing branches, need to pass ?repo= as well as ?branch=.

EricCousineau-TRI avatar Apr 15 '20 03:04 EricCousineau-TRI

Add'ly, it would be nice if the repository description (a) at a minimum used SDFormat (not "SDF"), and (b) perhaps linked to sdformat.org as well.

EricCousineau-TRI avatar Apr 15 '20 11:04 EricCousineau-TRI

Contribution-related stuff discussed here: https://github.com/osrf/sdformat/pull/243#issuecomment-614845955

EricCousineau-TRI avatar Apr 16 '20 19:04 EricCousineau-TRI

See example of ?repo= usage: https://github.com/osrf/sdf_tutorials/pull/3#issuecomment-621600107

EricCousineau-TRI avatar Apr 30 '20 18:04 EricCousineau-TRI

FTR Just some meta-level related issues (on documentation, traceability, etc.):

Posting in the context of: https://community.gazebosim.org/t/gsod-2020-ignition-robotics-on-boarding-guide/576

EricCousineau-TRI avatar May 30 '20 20:05 EricCousineau-TRI