Skip to content

Commit 23ae76c

Browse files
committed
preparing v1 branching
1 parent 5b5e3b4 commit 23ae76c

File tree

5 files changed

+76
-32
lines changed

5 files changed

+76
-32
lines changed

.github/CONTRIBUTING.md

Lines changed: 42 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,40 +1,67 @@
11
# Contributing to Buffalo
22

3-
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.
3+
First, thank you so much for wanting to contribute! It means so much that you
4+
care enough to want to contribute. We appreciate every PR from the smallest of
5+
typos to the be biggest of features.
6+
47

58
## First time committing to a go Repo?
69

7-
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:
10+
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),
11+
and you can now use them to easily set up a development environment. The steps
12+
involve:
813

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

14-
## How to contribute
1519

16-
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.
17-
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.
18-
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.
19-
4. Make sure tests run when doing `go test ./...`. You may need to do `go get -t ./...` first to get the testing dependencies.
20-
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 .`.
20+
## How to contribute
2121

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

2443
### Making your Pull Request
2544

26-
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.
45+
Open a PR against the `main` branch if your PR is for mainstrem or version
46+
specific branch e.g. `v1` if your PR is for specific version.
47+
Note that the valid branch for a new feature request PR should be `main` while
48+
a PR against a version specific branch are allowed only for bugfixes.
2749

28-
**WE WILL CLOSE ANY PR OPENED AGAINST MASTER BRANCH**.
2950

3051
## Documentation Welcome
3152

32-
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.
53+
Hands down the most important and the most welcome pull requests are for
54+
documentation. We LOVE documentation PRs, and so do all those that come after
55+
you.
56+
57+
Whether it's GoDoc or prose on [http://gobuffalo.io](http://gobuffalo.io) all
58+
documentation is welcome.
3359

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

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

3863
## Thank You
3964

40-
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.
65+
Once again, we want to take the chance to say thank you for wanting to
66+
contribute to Buffalo. This is a community project, and that means we **need**
67+
your help! Thank you so much.

.github/dependabot.yml

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,15 +3,16 @@ updates:
33
- package-ecosystem: "gomod"
44
directory: "/"
55
schedule:
6-
interval: "daily"
7-
target-branch: "development"
6+
interval: "weekly"
7+
day: "friday"
8+
target-branch: "main"
89
labels:
9-
- "gomod"
10+
- "dependencies"
1011

1112
- package-ecosystem: "github-actions"
1213
directory: "/"
1314
schedule:
1415
interval: "daily"
15-
target-branch: "development"
16+
target-branch: "main"
1617
labels:
17-
- "github-actions"
18+
- "process"

.github/workflows/stale.yml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -20,10 +20,10 @@ jobs:
2020
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."
2121
close-issue-message: "This issue was closed because it has been stalled for 5 days with no activity."
2222
close-pr-message: "This PR was closed because it has been stalled for 10 days with no activity."
23-
days-before-issue-stale: 30
24-
days-before-issue-close: 5
25-
days-before-pr-stale: 45
26-
days-before-pr-close: 10
23+
days-before-issue-stale: 28
24+
days-before-issue-close: 7
25+
days-before-pr-stale: 56
26+
days-before-pr-close: 14
2727
stale-issue-label: "no-issue-activity"
2828
exempt-issue-labels: "help wanted,enhancement"
2929
stale-pr-label: "no-pr-activity"

.github/workflows/standard-go-test.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ name: Standard Test
22

33
on:
44
push:
5-
branches: [ main ]
5+
branches: [ main v1 ]
66
pull_request:
77

88
jobs:

README.md

Lines changed: 23 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
<p align="center">
44
<a href="https://pkg.go.dev/github.com/gobuffalo/buffalo"><img src="https://pkg.go.dev/badge/github.com/gobuffalo/buffalo" alt="PkgGoDev"></a>
5-
<img src="https://github.com/gobuffalo/buffalo/workflows/Tests/badge.svg" alt="Tests Status" />
5+
<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>
66
<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>
77
<a href="https://www.codetriage.com/gobuffalo/buffalo"><img src="https://www.codetriage.com/gobuffalo/buffalo/badges/users.svg" alt="Open Source Helpers" /></a>
88
</p>
@@ -17,6 +17,14 @@ Buffalo **isn't just a framework**; it's a holistic web development environment
1717

1818
> I :heart: web dev in go again - Brian Ketelsen
1919
20+
## Versions
21+
22+
The current stable version of Buffalo core is v1 (`v1` branch).
23+
24+
Versions (branches):
25+
* `main` is for the current mainstream development.
26+
* `v1` is the current stable release.
27+
2028
## ⚠️ Important
2129

2230
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.
@@ -72,11 +80,19 @@ First, thank you so much for wanting to contribute! It means so much that you ca
7280

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

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

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

0 commit comments

Comments
 (0)