Skip to content

Improve Documentation for Unity Orb #80

@GabLeRoux

Description

@GabLeRoux

Issue: Improve Documentation for Unity Orb

Description

The current documentation for the Unity Orb could be improved to make it easier for users to contribute and test their own changes. Specifically:

  1. Add a link to the CONTRIBUTING.md file in the "How to Contribute" section of the README. This will provide users with a clear path to understand the guidelines and expectations for contributions.

  2. Document how to use a fork or a specific commit of the orb in workflows. This will help contributors test their changes before submitting a pull request.


Proposed Solution

To address these points:

  1. In the README under the "How to Contribute" section, add:

    For detailed guidelines on contributing, see [CONTRIBUTING.md](./CONTRIBUTING.md).

  2. Add a new section to the README titled Development or Testing Your Fork. It could include instructions similar to the following:


Development

If you would like to contribute to this orb and test your changes:

  1. Fork this repository.
  2. Make your changes in a new branch.
  3. Pack and publish your fork to a personal namespace:
circleci orb pack src > unity-orb.yml
circleci orb publish unity-orb.yml <your-namespace>/<your-orb-name>@dev:first
  1. Use your fork in your CircleCI workflow.
    Update your .circleci/config.yml to reference your development version:
orbs:
  unity: <your-namespace>/<your-orb-name>@dev:first

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions