diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index ac9fd4975..795320a8d 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -4,7 +4,7 @@ IMPORTANT: 1. Create an issue and wait for a maintainer to approve it BEFORE opening a pull request. 2. Don't open a work-in-progress pull request. If you open a PR, the PR must be ready to be reviewed. -3. If a pull request doesn't follow the previous elements, it will close. +3. If a pull request doesn't follow one of the previous elements, it will be closed. Also, pull requests from a fork inside a GitHub organization are not allowed because of access limitation on them. Only pull requests from personal forks are allowed. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a0005cff8..05e4fa994 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -10,7 +10,7 @@ To ensure a great and easy experience for everyone, please review the few guidel - If both of the above do not apply, create a new issue and include as much information as possible. Bug reports should include all information a person could need to reproduce your problem without the need to -follow up for more information. If possible, provide detailed steps for us to reproduce it, the expected behaviour and the actual behaviour. +follow up for more information. If possible, provide detailed steps for us to reproduce it, the expected behavior and the actual behavior. ## Feature proposals and requests @@ -20,31 +20,26 @@ It is up to you to make a strong point about your proposal and convince us of th ## Pull requests +Create an issue and wait for a maintainer to approve it BEFORE opening a pull request. + Patches, new features and improvements are a great way to help the project. Please keep them focused on one thing and do not include unrelated commits. -All pull requests which alter the behaviour of the program, add new behaviour or somehow alter code in a non-trivial way should **always** include tests. +All pull requests that alter the behavior of the program, +add new behavior or somehow alter code in a non-trivial way should **always** include tests. -If you want to contribute a significant pull request (with a non-trivial workload for you) please **ask first**. We do not want you to spend -a lot of time on something the project's developers might not want to merge into the project. - -**IMPORTANT**: By submitting a patch, you agree to allow the project -owners to license your work under the terms of the [MIT License](LICENSE). +**IMPORTANT**: By submitting a patch, you agree to allow the project owners to license your work under the terms of the [MIT License](LICENSE). ### How to create a pull request Requirements: -- `go` v1.15+ +- `go` v1.24+ - environment variable: `GO111MODULE=on` First, you have to install [GoLang](https://golang.org/doc/install) and [golangci-lint](https://github.com/golangci/golangci-lint#install). ```bash -# Create the root folder -mkdir -p $GOPATH/src/github.com/go-acme -cd $GOPATH/src/github.com/go-acme - # clone your fork git clone git@github.com:YOUR_USERNAME/lego.git cd lego @@ -56,14 +51,12 @@ git fetch upstream ```bash # Create your branch -git checkout -b my-feature +git switch -c my-feature ## Create your code ## ``` ```bash -# Format -make fmt # Linters make checks # Tests