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.

Sign up for GitHub

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

Update contribution guidelines and add development section #81

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Update contribution guidelines and add development section #81

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e624565
Update contribution guidelines and add development section
GabLeRoux Nov 22, 2024
1618956
Update instructions for development and deployment of private orbs
GabLeRoux Nov 22, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 27 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Easily build and test your Unity project.

### How to Contribute

We welcome [issues](https://github.com/game-ci/unity-orb/issues) to and [pull requests](https://github.com/game-ci/unity-orb/pulls) against this repository!
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).

### How to Publish An Update

Expand Down Expand Up @@ -44,3 +44,29 @@ circleci orb pack src > unity-orb.yml
circleci orb publish unity-orb.yml <my-namespace>/<my-orb-name>@dev:first
circleci orb publish promote <my-namespace>/<my-orb-name>@dev:first patch
```

## 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
```

4. **Use your fork in your CircleCI workflow.**

Update your `.circleci/config.yml` to reference your development version:

```yaml
orbs:
unity: <your-namespace>/<your-orb-name>@dev:first
```

## License

[MIT](LICENSE)