diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 4066242..612ae57 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -24,8 +24,7 @@ Thank you for showing interest in contributing to Pretendo Network! As an open s > 2. **Ownership & Rights** – You may only contribute content you own. Do not submit anything that is: > - Owned by someone else (unless properly licensed for this project). > - A trade secret, under NDA, or otherwise confidential. -> 3. **Respect for Nintendo’s IP** – We strictly avoid infringing on Nintendo’s intellectual property. If you have had access to Nintendo’s proprietary materials (legally or otherwise), we may take steps to ensure compliance, including blocking contributions or removing existing ones. - +> 3. **Respect for Nintendo’s IP** – We strictly avoid infringing on Nintendo’s intellectual property. If you have had access to Nintendo’s proprietary materials (legally or otherwise), we may take steps to ensure compliance, including blocking contributions or removing existing ones. Before diving into the contribution process, we recommend familiarizing yourself with our project's existing repositories. By studying our existing codebases, issues, and pull requests you will get a better sense of direction of how we operate. Additionally, please review our [Code of Conduct](CODE_OF_CONDUCT.md) to ensure a respectful and inclusive environment for all participants. Given that our project's main goal is to emulate Nintendo Network, it is also highly recommended that you familiarize yourself with how these services operate. Information on these topics, and our libraries, can be found both on our [wiki](https://nintendo-wiki.pretendo.network/docs/) and our (in progress) [developer documentation](https://developer.pretendo.network/home). @@ -126,4 +125,4 @@ We ask that you have patience with us as we review your pull request. Pretendo N We do not require 100% code coverage in any tests. We do not currently have strict rules regarding tests, however we may ask that tests be provided for large or complex changes. # Licensing -Unless otherwise specified all code is licensed under [GNU AGPLv3](https://choosealicense.com/licenses/agpl-3.0), including that of outside contributions. This license allows users many freedoms to use our code in their own applications, including private and commercial use, while ensuring that all derivatives remain under this same license and keeps the source available, even when used over a network. A repository's license may not be changed by outside contributors unless that change is done with good reason, has been approved by the core development team, and is done with the consent of all relevant contributors. +Unless otherwise specified all code is licensed under [GNU AGPLv3](https://choosealicense.com/licenses/agpl-3.0), including that of outside contributions. This license allows users many freedoms to use our code in their own applications, including private and commercial use, while ensuring that all derivatives remain under this same license and keeps the source available, even when used over a network. A repository's license may not be changed by outside contributors unless that change is done with good reason, has been approved by the core development team, and is done with the consent of all relevant contributors. \ No newline at end of file diff --git a/README.md b/README.md index 8c89dfd..94e7122 100644 --- a/README.md +++ b/README.md @@ -1,18 +1,10 @@ -# About Pretendo Network -Pretendo is an open source Nintendo Network replacement that aims to build custom servers for the Wii U and 3DS family of consoles. Our goal is to preserve the online functionality of these consoles, to allow players to continue to play their favorite Wii U and 3DS games to their fullest capacity. +# Pretendo Network -For more information on the project such as current goals, project status and other news, visit [our website](https://pretendo.network). +This special repository contains community files and common templates. -As a fully open-source project, Pretendo welcomes contributions made by the community. If you are interested in contributing, please refer to the [contribution guide](../.github/CONTRIBUTING.md). +## Contents -## Official Links - -* [Website](https://pretendo.network) -* [Discord](https://discord.gg/pretendo) -* [Forum](https://forum.pretendo.network/) -* [Twitter](https://twitter.com/pretendonetwork) - - -## License - -This project is licensed under the [GNU Affero General Public License version 3](../LICENSE) +* [License](LICENSE) +* [Security Policy](.github/SECURITY.md) +* [Code of Conduct](.github/CODE_OF_CONDUCT.md) +* [Contribution Guide](.github/CONTRIBUTING.md) diff --git a/workflow-templates/docker.properties.json b/workflow-templates/docker.properties.json deleted file mode 100644 index fc7aeb6..0000000 --- a/workflow-templates/docker.properties.json +++ /dev/null @@ -1,11 +0,0 @@ -{ - "name": "Docker Build Workflow", - "description": "Workflow to build an AMD64 and ARM64 Docker build on push and PR", - "iconName": "octicon package", - "categories": [ - "Docker" - ], - "filePatterns": [ - "^Dockerfile" - ] -} diff --git a/workflow-templates/docker.yml b/workflow-templates/docker.yml deleted file mode 100644 index 2691cb2..0000000 --- a/workflow-templates/docker.yml +++ /dev/null @@ -1,101 +0,0 @@ -name: Build and Publish Docker Image - -on: - push: - pull_request: - workflow_dispatch: - -env: - REGISTRY: ghcr.io - IMAGE_NAME: ${{ github.repository }} - DEFAULT_BRANCH: ${{ format('refs/heads/{0}', github.event.repository.default_branch) }} - SHOULD_PUSH_IMAGE: ${{ (github.event_name == 'push' && (github.ref == format('refs/heads/{0}', github.event.repository.default_branch) || github.ref == 'refs/heads/dev')) || github.event_name == 'workflow_dispatch' }} - -jobs: - build-publish-amd64: - name: Build and Publish Docker Image (amd64) - runs-on: ubuntu-latest - - permissions: - contents: read - packages: write - - steps: - - name: Set up QEMU for Docker - uses: docker/setup-qemu-action@v3 - - - name: Set up Docker Buildx - uses: docker/setup-buildx-action@v3 - - - name: Log into the container registry - if: ${{ env.SHOULD_PUSH_IMAGE == 'true' }} - uses: docker/login-action@v3 - with: - registry: ${{ env.REGISTRY }} - username: ${{ github.actor }} - password: ${{ secrets.GITHUB_TOKEN }} - - - name: Extract Docker metadata - id: meta - uses: docker/metadata-action@v5 - with: - images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }} - tags: | - type=raw,value=latest,enable=${{ github.ref == env.DEFAULT_BRANCH }} - type=raw,value=edge,enable=${{ github.ref == 'refs/heads/dev' }} - type=sha - - - name: Build and push Docker image - id: build-and-push - uses: docker/build-push-action@v6 - with: - platforms: linux/amd64 - push: ${{ env.SHOULD_PUSH_IMAGE }} - tags: ${{ steps.meta.outputs.tags }} - labels: ${{ steps.meta.outputs.labels }} - cache-from: type=gha - cache-to: type=gha,mode=max - - build-publish-arm64: - name: Build and Publish Docker Image (arm64) - runs-on: ubuntu-24.04-arm - - permissions: - contents: read - packages: write - - steps: - - name: Set up QEMU for Docker - uses: docker/setup-qemu-action@v3 - - - name: Set up Docker Buildx - uses: docker/setup-buildx-action@v3 - - - name: Log into the container registry - if: ${{ env.SHOULD_PUSH_IMAGE == 'true' }} - uses: docker/login-action@v3 - with: - registry: ${{ env.REGISTRY }} - username: ${{ github.actor }} - password: ${{ secrets.GITHUB_TOKEN }} - - - name: Extract Docker metadata - id: meta - uses: docker/metadata-action@v5 - with: - images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }} - tags: | - type=raw,value=latest-arm,enable=${{ github.ref == env.DEFAULT_BRANCH }} - type=raw,value=edge-arm,enable=${{ github.ref == 'refs/heads/dev' }} - type=sha,suffix=-arm - - - name: Build and push Docker image - id: build-and-push - uses: docker/build-push-action@v6 - with: - platforms: linux/arm64 - push: ${{ env.SHOULD_PUSH_IMAGE }} - tags: ${{ steps.meta.outputs.tags }} - labels: ${{ steps.meta.outputs.labels }} - cache-from: type=gha - cache-to: type=gha,mode=max