Skip to content

Commit bf07f58

Browse files
authored
Merge pull request #805 from lcreid/contributing-v6
Add v6 to Contributing Doc
2 parents 9dbfa22 + 701ba43 commit bf07f58

1 file changed

Lines changed: 24 additions & 0 deletions

File tree

‎CONTRIBUTING.md‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,30 @@ There are a number of ways you can contribute to `bootstrap_form`:
1010
- Fix a bug or add a new feature.
1111
- Add to the documentation.
1212
- Review pull requests.
13+
- **New** [Help migrate to Bootstrap 6](#bootstrap-6).
14+
15+
## Bootstrap 6
16+
17+
Bootstrap 6 is coming, and that means extensive changes to `bootstrap_form`.
18+
We're also going to take advantage of the change in major version number
19+
to make the gem more flexible and easier to use and maintain.
20+
This will mean some breaking changes, if you're migrating from `bootstrap_form` version 5.
21+
22+
For now, the main thing to keep in mind if you want to submit a PR for the migration to Bootstrap 6,
23+
is to branch your code from the `bootstrap-6` branch in this repository,
24+
and submit your PR to merge on the `bootstrap-6` branch, _not_ `main`.
25+
26+
If your PR means that something works differently in `bootstrap_form` version 6 compared to version 5,
27+
describe the changes in `UPGRADE-6.0.md`.
28+
29+
If you want to help test the `bootstrap-6` branch, that's a great way to contribute.
30+
Change your `Gemfile` to read:
31+
32+
```
33+
gem "bootstrap_form", git: "https://bootstrap-ruby/bootstrap_form", branch: "bootstrap-6"
34+
```
35+
36+
If you find bugs, missing features, or have suggestions, create an issue on GitHub.
1337

1438
## Testing
1539

0 commit comments

Comments
 (0)