Skip to content

Commit

Permalink
ci: don't compare readmes
Browse files Browse the repository at this point in the history
  • Loading branch information
nattb8 committed Dec 17, 2024
1 parent ae3786d commit 8a301ce
Show file tree
Hide file tree
Showing 2 changed files with 1 addition and 38 deletions.
8 changes: 0 additions & 8 deletions .github/workflows/diff.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,14 +15,6 @@ jobs:
mode: strict
tolerance: same
output: LICENSE-diff.txt
- name: Check that the README files are the exact same
uses: LouisBrunner/[email protected]
with:
old: README.md
new: src/Packages/Passport/README.md
mode: strict
tolerance: same
output: README-diff.txt
- name: Check that the CHANGELOG files are the exact same
uses: LouisBrunner/[email protected]
with:
Expand Down
31 changes: 1 addition & 30 deletions src/Packages/Passport/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,33 +15,4 @@ The Immutable SDK Passport package for Unity helps you integrate your game with
# Documentation

* [Immutable X](https://docs.immutable.com/docs/x/sdks/unity)
* [Immutable zkEVM](https://docs.immutable.com/docs/zkEVM/sdks/unity)

## Contributing

Thank you for your interest in contributing to our project! Here's a quick guide on how you can get started:

1. **Fork this Repository**: Fork the repository to your GitHub account by clicking the "Fork" button at the top right of the repository page.
2. **Create a Branch**: Once you've forked the repository, create a new branch in your forked repository where you'll be making your changes. Branch naming convention is enforced [according to patterns here](https://github.com/deepakputhraya/action-branch-name).
3. **Make Changes**: Make the necessary changes in your branch. Ensure that your changes are clear, well-documented, and aligned with the project's guidelines.
4. **Commit Changes**: Commit your changes with clear and descriptive messages following [commit message pattern here](https://github.com/conventional-changelog/commitlint?tab=readme-ov-file#what-is-commitlint). It follows [Conventional Commits specification](https://www.conventionalcommits.org/en/v1.0.0/#specification), which helps maintain a consistent and informative commit history. Read [here](https://www.conventionalcommits.org/en/v1.0.0/#why-use-conventional-commits) to learn more about the benefits of Conventional Commits.
5. **Create a Pull Request (PR)**: After you've made and committed your changes, create a PR against the original repository. Provide a clear description of the changes you've made in the PR.
6. **Example Contribution**: Refer to [this contribution](https://github.com/immutable/unity-immutable-sdk/pull/182) as an example.

## Getting Help

Immutable X is open to all to build on, with no approvals required. If you want to talk to us to learn more, or apply for developer grants, click below:

[Contact us](https://www.immutable.com/contact)

### Project Support

To get help from other developers, discuss ideas, and stay up-to-date on what's happening, become a part of our community on Discord.

[Join us on Discord](https://discord.gg/TkVumkJ9D6)

#### Still need help?

You can also apply for marketing support for your project. Or, if you need help with an issue related to what you're building with Immutable X, click below to submit an issue. Select _I have a question_ or _issue related to building on Immutable X_ as your issue type.

[Contact support](https://support.immutable.com/hc/en-us/requests/new)
* [Immutable zkEVM](https://docs.immutable.com/docs/zkEVM/sdks/unity)

0 comments on commit 8a301ce

Please sign in to comment.