Skip to content
This repository has been archived by the owner on Feb 24, 2024. It is now read-only.

Commit

Permalink
preparing v1 branching
Browse files Browse the repository at this point in the history
  • Loading branch information
sio4 committed Aug 25, 2022
1 parent 5b5e3b4 commit 23ae76c
Show file tree
Hide file tree
Showing 5 changed files with 76 additions and 32 deletions.
57 changes: 42 additions & 15 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,40 +1,67 @@
# Contributing to Buffalo

First, thank you so much for wanting to contribute! It means so much that you care enough to want to contribute. We appreciate every PR from the smallest of typos to the be biggest of features.
First, thank you so much for wanting to contribute! It means so much that you
care enough to want to contribute. We appreciate every PR from the smallest of
typos to the be biggest of features.


## First time committing to a go Repo?

Support for go Modules was introduced in [Release v0.13.0-beta.1](https://github.com/gobuffalo/buffalo/releases/tag/v0.13.0-beta.1), and you can now use them to easily set up a development environment. The steps involve:
Support for go Modules was introduced in [Release v0.13.0-beta.1](https://github.com/gobuffalo/buffalo/releases/tag/v0.13.0-beta.1),
and you can now use them to easily set up a development environment. The steps
involve:

1. Fork the repo
2. Clone the repo to any location in your work station
3. Run `go get` to install dependencies
4. Read the contribution guideline below

## How to contribute

1. Check [https://github.com/gobuffalo/buffalo/issues](https://github.com/gobuffalo/buffalo/issues) to make sure you're not working on a duplicate issue or PR.
2. If you want to implement a new feature that doesn't have an issue open, please open one and ask for feedback on the feature before spending a lot of time working on it. It's possible the feature has already been discussed, or it's out of scope, or some other reason that might later prevent a PR from being accepted. The [#buffalo](https://gobuffalo.io/docs/slack) channel on gophers.slack.com is a great place to seek this kind of guidance.
3. Write your feature/fix and make sure to include tests. Tests are an **absolute** requirement for any pull request. Please make sure to use the same testing style and libraries as the rest of the tests.
4. Make sure tests run when doing `go test ./...`. You may need to do `go get -t ./...` first to get the testing dependencies.
5. (Optional) There is a much longer set of integration tests that can be run. These will be run by github actions when you open a PR. If you want to run them locally, you can by running `docker build .`.
## How to contribute

Feel free to ask for help, but don't target a specific person (unless you're replying to this person). e.g. don't @ markbates, but @ gobuffalo/core-managers instead.
1. Check [https://github.com/gobuffalo/buffalo/issues](https://github.com/gobuffalo/buffalo/issues)
to make sure you're not working on a duplicate issue or PR.
2. If you want to implement a new feature that doesn't have an issue open,
please open one and ask for feedback on the feature before spending a lot
of time working on it. It's possible the feature has already been discussed,
or it's out of scope, or some other reason that might later prevent a PR
from being accepted.
The [#buffalo](https://gophers.slack.com/messages/buffalo/) channel on
gophers.slack.com is a great place to seek this kind of guidance.
3. Write your feature/fix and make sure to include tests. Tests are an
**absolute** requirement for any pull request. Please make sure to use the
same testing style and libraries as the rest of the tests.
4. Make sure tests run when doing `go test ./...`. You may need to do
`go get -t ./...` first to get the testing dependencies.
5. (Optional) There is a much longer set of integration tests that can be run.
These will be run by github actions when you open a PR. If you want to run
them locally, you can by running `docker build .`.

Feel free to ask for help, but don't target a specific person (unless you're
replying to this person). @ gobuffalo/core-managers instead.

### Making your Pull Request

Open a PR against the `development` branch. **_DO NOT_** open one against `master`. All "unreleased" work happens in the `development` branch, and we will fix the master branch if necessary.
Open a PR against the `main` branch if your PR is for mainstrem or version
specific branch e.g. `v1` if your PR is for specific version.
Note that the valid branch for a new feature request PR should be `main` while
a PR against a version specific branch are allowed only for bugfixes.

**WE WILL CLOSE ANY PR OPENED AGAINST MASTER BRANCH**.

## Documentation Welcome

Hands down the most important and the most welcome pull requests are for documentation. We LOVE documentation PRs, and so do all those that come after you.
Hands down the most important and the most welcome pull requests are for
documentation. We LOVE documentation PRs, and so do all those that come after
you.

Whether it's GoDoc or prose on [http://gobuffalo.io](http://gobuffalo.io) all
documentation is welcome.

Whether it's GoDoc or prose on [http://gobuffalo.io](http://gobuffalo.io) all documentation is welcome.
You can submit PRs to change the website and/or docs on [https://github.com/gobuffalo/docs](https://github.com/gobuffalo/docs).

You can submit PRs to change the website and/or docs on [https://github.com/gobuffalo/gobuffalo](https://github.com/gobuffalo/gobuffalo).

## Thank You

Once again, we want to take the chance to say thank you for wanting to contribute to Buffalo. This is a community project, and that means we **need** your help! Thank you so much.
Once again, we want to take the chance to say thank you for wanting to
contribute to Buffalo. This is a community project, and that means we **need**
your help! Thank you so much.
11 changes: 6 additions & 5 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,16 @@ updates:
- package-ecosystem: "gomod"
directory: "/"
schedule:
interval: "daily"
target-branch: "development"
interval: "weekly"
day: "friday"
target-branch: "main"
labels:
- "gomod"
- "dependencies"

- package-ecosystem: "github-actions"
directory: "/"
schedule:
interval: "daily"
target-branch: "development"
target-branch: "main"
labels:
- "github-actions"
- "process"
8 changes: 4 additions & 4 deletions .github/workflows/stale.yml
Original file line number Diff line number Diff line change
Expand Up @@ -20,10 +20,10 @@ jobs:
stale-pr-message: "This PR is stale because it has been open 45 days with no activity. Remove stale label or comment or this will be closed in 10 days."
close-issue-message: "This issue was closed because it has been stalled for 5 days with no activity."
close-pr-message: "This PR was closed because it has been stalled for 10 days with no activity."
days-before-issue-stale: 30
days-before-issue-close: 5
days-before-pr-stale: 45
days-before-pr-close: 10
days-before-issue-stale: 28
days-before-issue-close: 7
days-before-pr-stale: 56
days-before-pr-close: 14
stale-issue-label: "no-issue-activity"
exempt-issue-labels: "help wanted,enhancement"
stale-pr-label: "no-pr-activity"
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/standard-go-test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ name: Standard Test

on:
push:
branches: [ main ]
branches: [ main v1 ]
pull_request:

jobs:
Expand Down
30 changes: 23 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

<p align="center">
<a href="https://pkg.go.dev/github.com/gobuffalo/buffalo"><img src="https://pkg.go.dev/badge/github.com/gobuffalo/buffalo" alt="PkgGoDev"></a>
<img src="https://github.com/gobuffalo/buffalo/workflows/Tests/badge.svg" alt="Tests Status" />
<a href="https://github.com/gobuffalo/buffalo/actions/workflows/standard-go-test.yml"><img src="https://github.com/gobuffalo/buffalo/actions/workflows/standard-go-test.yml/badge.svg"></a>
<a href="https://goreportcard.com/report/github.com/gobuffalo/buffalo"><img src="https://goreportcard.com/badge/github.com/gobuffalo/buffalo" alt="Go Report Card" /></a>
<a href="https://www.codetriage.com/gobuffalo/buffalo"><img src="https://www.codetriage.com/gobuffalo/buffalo/badges/users.svg" alt="Open Source Helpers" /></a>
</p>
Expand All @@ -17,6 +17,14 @@ Buffalo **isn't just a framework**; it's a holistic web development environment

> I :heart: web dev in go again - Brian Ketelsen
## Versions

The current stable version of Buffalo core is v1 (`v1` branch).

Versions (branches):
* `main` is for the current mainstream development.
* `v1` is the current stable release.

## ⚠️ Important

Buffalo works only with Go [modules](https://blog.golang.org/using-go-modules). `GOPATH` mode is likely to break most of the functionality of the Buffalo eco-system. Please see [this blog post](https://blog.gobuffalo.io/the-road-to-1-0-requiring-modules-5672c6b015e5) for more information.
Expand Down Expand Up @@ -72,11 +80,19 @@ First, thank you so much for wanting to contribute! It means so much that you ca

**Here are the core rules to respect**:

- If you have any question, please consider using the [Slack channel](https://gobuffalo.io/docs/slack) (-#buffalo-, *#buffalo_fr* or *#buffalo-dev* for contribution related questions) or [Stack Overflow](https://stackoverflow.com/questions/tagged/buffalo). We use GitHub issues for **bug reports and feature requests only**.
- All contributors of this project are working on their free time: be patient and kind. :-
- Consider opening an issue **BEFORE** creating a Pull request (PR): you won't lose your -ime on fixing non-existing bugs, or fixing the wrong bug. Also we can help you to produce the best PR!
- All PRs **MUST** be opened against the *development* branch. If you want to write an ho--fix, we'll first fix the *development* branch before moving the patch to *master* branch.

**WE WILL CLOSE ANY ISSUE OR PR NOT FOLLOWING THESE CORE RULES**.
- If you have any question, please consider using the
[Slack channel](https://gophers.slack.com/messages/buffalo/) (-#buffalo-,
*#buffalo_fr* or *#buffalo-dev* for contribution related questions) or
[Stack Overflow](https://stackoverflow.com/questions/tagged/buffalo).
We use GitHub issues for **bug reports and feature requests only**.
- All contributors of this project are working on their free time: be patient
and kind. :-
- Consider opening an issue **BEFORE** creating a Pull request (PR): you won't
lose your time on fixing non-existing bugs, or fixing the wrong bug. Also we
can help you to produce the best PR!
- Open a PR against the `main` branch if your PR is for mainstrem or version
specific branch e.g. `v1` if your PR is for specific version.
Note that the valid branch for a new feature request PR should be `main`
while a PR against a version specific branch are allowed only for bugfixes.

For the full contribution guidelines, please read [CONTRIBUTING](.github/CONTRIBUTING.md).

0 comments on commit 23ae76c

Please sign in to comment.