Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve Documentation for Unity Orb #80

Open
GabLeRoux opened this issue Nov 22, 2024 · 2 comments · May be fixed by #81
Open

Improve Documentation for Unity Orb #80

GabLeRoux opened this issue Nov 22, 2024 · 2 comments · May be fixed by #81

Comments

@GabLeRoux
Copy link
Member

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
@GabLeRoux
Copy link
Member Author

@coderabbitai read ./README.md and ./CONTRIBUTING.md and suggest changes.

Copy link
Contributor

coderabbitai bot commented Nov 22, 2024

Tip

For best results, initiate chat on the files or code changes.

@GabLeRoux, after reviewing README.md and CONTRIBUTING.md, I have the following suggestions:

  1. Add a link to CONTRIBUTING.md in the README: In the "How to Contribute" section of README.md, consider adding a direct link to the CONTRIBUTING.md file to provide clear guidelines for contributors. For example:

    ### How to Contribute
    
    We welcome [issues](https://github.com/game-ci/unity-orb/issues) and [pull requests](https://github.com/game-ci/unity-orb/pulls) against this repository! For detailed guidelines, see [CONTRIBUTING.md](./CONTRIBUTING.md).
  2. Document how to use a fork or specific commit of the orb: Adding a new section to the README.md titled "Development" or "Testing Your Fork" can help contributors test their changes. Here's a suggested addition:

    ## Development
    
    If you'd 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:
    
       ```bash
       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
    
    

These updates should make it easier for contributors to understand how to contribute and test their changes. Let me know your thoughts!

🔗 Analysis chain
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Output the contents of README.md
cat README.md

# Output the contents of CONTRIBUTING.md
cat CONTRIBUTING.md

Length of output: 4024

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant