diff --git a/.github/workflows/CI.yml b/.github/workflows/CI.yml index 78438f5..b6f7afc 100644 --- a/.github/workflows/CI.yml +++ b/.github/workflows/CI.yml @@ -2,7 +2,7 @@ name: CI on: push: branches: - - master + - main tags: '*' pull_request: concurrency: diff --git a/CHANGELOG.md b/CHANGELOG.md index 32fea41..301df1f 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -167,7 +167,7 @@ Modules and variables were renamed. Proof of concept and master thesis submission. -[Unreleased]: https://github.com/railtoolkit/TrainRun.jl/compare/v0.8...master +[Unreleased]: https://github.com/railtoolkit/TrainRun.jl/compare/v0.8...main [0.8]: https://github.com/railtoolkit/TrainRun.jl/compare/v0.7...v0.8 [0.7]: https://github.com/railtoolkit/TrainRun.jl/compare/v0.6.2...v0.7 [0.6.2]: https://github.com/railtoolkit/TrainRun.jl/compare/v0.6.1...v0.6.2 diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 3bcb403..cf5bac4 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -44,7 +44,7 @@ TODO! or related issues for context, before opening a new issue * Including minimal examples is greatly appreciated * If it's a bug, or unexpected behaviour, reproducing on the latest development version - (`Pkg.add(name="TrainRun", rev="master")`) is a good gut check and can streamline the process, + (`Pkg.add(name="TrainRun", rev="main")`) is a good gut check and can streamline the process, along with including the first two lines of output from `versioninfo()` ## Style Guidelines @@ -53,13 +53,13 @@ TODO ## Git Recommendations For Pull Requests -* Avoid working from the `master` branch of your fork, creating a new branch will make it - easier if TrainRun.jl `master` branch changes and you need to update your pull request; -* All PRs and issues should be opened against the `master` branch not against the current release; +* Avoid working from the `main` branch of your fork, creating a new branch will make it + easier if TrainRun.jl `main` branch changes and you need to update your pull request; +* All PRs and issues should be opened against the `main` branch not against the current release; * Run tests of your code before sending any commit to GitHub. Only push changes when the tests of the change are passing locally. In particular note that it is not a problem if you send several commits in one push command to GitHub as CI will be run only once then; -* If any conflicts arise due to changes in TrainRun.jl `master` branch, prefer updating your pull +* If any conflicts arise due to changes in TrainRun.jl `main` branch, prefer updating your pull request branch with `git rebase` (rather than `git merge`), since the latter will introduce a merge commit that might confuse GitHub when displaying the diff of your PR, which makes your changes more difficult to review. Alternatively use conflict resolution tool available at GitHub; diff --git a/README.md b/README.md index a0aea6e..de40d17 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ # TrainRun [![License: ISC](https://img.shields.io/badge/license-ISC-green.svg)](https://opensource.org/licenses/ISC) [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.6448563.svg)](https://doi.org/10.5281/zenodo.6448563) -[![Build Status](https://github.com/railtoolkit/TrainRun.jl/actions/workflows/CI.yml/badge.svg?branch=master)](https://github.com/railtoolkit/TrainRun.jl/actions/workflows/CI.yml?query=branch%3Amaster) +[![Build Status](https://github.com/railtoolkit/TrainRun.jl/actions/workflows/CI.yml/badge.svg?branch=main)](https://github.com/railtoolkit/TrainRun.jl/actions/workflows/CI.yml?query=branch%3Amain) ------------ diff --git a/docs/make.jl b/docs/make.jl index 4b52efb..f2bf563 100644 --- a/docs/make.jl +++ b/docs/make.jl @@ -20,5 +20,5 @@ makedocs(; deploydocs(; repo="github.com/railtoolkit/TrainRun.jl", - devbranch="master", + devbranch="development", )