-
-
Notifications
You must be signed in to change notification settings - Fork 12
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
Comments
@coderabbitai read ./README.md and ./CONTRIBUTING.md and suggest changes. |
Tip For best results, initiate chat on the files or code changes. @GabLeRoux, after reviewing
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 executedThe following scripts were executed for the analysis: Script:
Length of output: 4024 |
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:
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.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:
In the README under the "How to Contribute" section, add:
Add a new section to the README titled
Development
orTesting Your Fork
. It could include instructions similar to the following:Development
If you would like to contribute to this orb and test your changes:
Update your
.circleci/config.yml
to reference your development version:The text was updated successfully, but these errors were encountered: