diff --git a/.github/dependabot.yml b/.github/dependabot.yml index 4656be7..179bba3 100644 --- a/.github/dependabot.yml +++ b/.github/dependabot.yml @@ -4,13 +4,13 @@ updates: directory: "/" schedule: interval: "weekly" - target-branch: "master" + target-branch: "main" reviewers: - "leviem1" - package-ecosystem: "gradle" directory: "/" schedule: interval: "weekly" - target-branch: "master" + target-branch: "main" reviewers: - "leviem1" diff --git a/.github/workflows/artifact.yml b/.github/workflows/artifact.yml index 13508fe..f534f1b 100644 --- a/.github/workflows/artifact.yml +++ b/.github/workflows/artifact.yml @@ -3,10 +3,10 @@ name: Build and Artifact on: pull_request: branches: - - 'master' + - 'main' push: branches: - - 'master' + - 'main' jobs: build: diff --git a/.github/workflows/check.yml b/.github/workflows/check.yml index 68ccd57..69fc1b9 100644 --- a/.github/workflows/check.yml +++ b/.github/workflows/check.yml @@ -3,7 +3,7 @@ name: Build and Check on: push: branches-ignore: - - 'master' + - 'main' jobs: build: diff --git a/README.md b/README.md index 534d22d..550de88 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ A template for building PaperMC plugins! ## Features ### Github Actions 🎬 * Draft release on tag push -* Build artifact on pull requests and pushes to master +* Build artifact on pull requests and pushes to main * Build and check on all other branches ### Bots 🤖 @@ -116,18 +116,18 @@ permissions: ## Creating a Release Below are the steps you should follow to create a release. -1. Create a tag on `master` using semantic versioning (e.g. v0.1.0) +1. Create a tag on `main` using semantic versioning (e.g. v0.1.0) 2. Push the tag and get some coffee while the workflows run 3. Add a description to the release draft once it's been automatically created ## Contributing ### General workflow -1. First, pull any changes from `master` to make sure you're up-to-date -2. Create a branch from `master` +1. First, pull any changes from `main` to make sure you're up-to-date +2. Create a branch from `main` * Give your branch a name that describes your change (e.g. add-scoreboard) * Focus on one change per branch * Keep your commits small, and write descriptive commit messages -3. When you're ready, create a pull request to `master` with a descriptive title, and listing any changes made in its description +3. When you're ready, create a pull request to `main` with a descriptive title, and listing any changes made in its description * Link any issues that your pull request is related to as well #### Example: @@ -138,7 +138,7 @@ ADDED - Scoreboard displayed at in-game at game end CHANGED - Updated `StorageManager` class to persist scoreboard data ``` -After the pull request is reviewed, approved, and passes all automated checks, it will be merged into master. +After the pull request is reviewed, approved, and passes all automated checks, it will be merged into main. ### Building locally Thanks to [Gradle](https://gradle.org/), building locally is easy no matter what platform you're on. Simply run the following command: