From 8a301ceb94338f605589531023ac9ce46eee81b1 Mon Sep 17 00:00:00 2001 From: Natalie Bunduwongse Date: Tue, 17 Dec 2024 17:30:19 +1300 Subject: [PATCH] ci: don't compare readmes --- .github/workflows/diff.yml | 8 -------- src/Packages/Passport/README.md | 31 +------------------------------ 2 files changed, 1 insertion(+), 38 deletions(-) diff --git a/.github/workflows/diff.yml b/.github/workflows/diff.yml index d18f9f65..7f812586 100644 --- a/.github/workflows/diff.yml +++ b/.github/workflows/diff.yml @@ -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/diff-action@v2.0.0 - 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/diff-action@v2.0.0 with: diff --git a/src/Packages/Passport/README.md b/src/Packages/Passport/README.md index 094e7cc3..2fdd696e 100644 --- a/src/Packages/Passport/README.md +++ b/src/Packages/Passport/README.md @@ -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) \ No newline at end of file