From 95cd56d21583781465071d8bc7ff28687cb6d464 Mon Sep 17 00:00:00 2001 From: bashbunni Date: Tue, 15 Oct 2024 14:46:11 -0700 Subject: [PATCH 1/3] docs(contributing): use org contributing guidelines --- CONTRIBUTING.md | 13 ------------- README.md | 4 ++++ 2 files changed, 4 insertions(+), 13 deletions(-) delete mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md deleted file mode 100644 index 19ee18c766..0000000000 --- a/CONTRIBUTING.md +++ /dev/null @@ -1,13 +0,0 @@ -# Contributing - -Pull requests are welcome for any changes. - -Consider opening an issue for larger changes to get feedback on the idea from the team. - -If your change touches parts of the Bubble Tea renderer or internals, make sure -that all the examples in the `examples/` folder continue to run correctly. - -For commit messages, please use conventional commits[^1] to make it easier to -generate release notes. - -[^1]: https://www.conventionalcommits.org/en/v1.0.0 diff --git a/README.md b/README.md index f994fe35bd..495faf3910 100644 --- a/README.md +++ b/README.md @@ -354,6 +354,10 @@ For more applications built with Bubble Tea see [Charm & Friends][community]. Is there something cool you made with Bubble Tea you want to share? [PRs][community] are welcome! +## Contributing + +See [contributing](/contributing). + ## Feedback We’d love to hear your thoughts on this project. Feel free to drop us a note! From 15b444c00bda095f2a02a37ef031ea1e8bae0bb1 Mon Sep 17 00:00:00 2001 From: bashbunni Date: Tue, 15 Oct 2024 14:48:33 -0700 Subject: [PATCH 2/3] fix(docs): fix link to contribution page --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 495faf3910..01e20e0366 100644 --- a/README.md +++ b/README.md @@ -356,7 +356,9 @@ welcome! ## Contributing -See [contributing](/contributing). +See [contributing][contribute]. + +[contribute]: http://github.com/charmbracelet/bubbletea/contribute ## Feedback From a2477251dba641f307a7a18b63ebda12cc0cf08e Mon Sep 17 00:00:00 2001 From: bashbunni Date: Tue, 15 Oct 2024 14:59:41 -0700 Subject: [PATCH 3/3] docs: use https for links, not http --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 01e20e0366..4dbe75eb14 100644 --- a/README.md +++ b/README.md @@ -254,8 +254,8 @@ look at the [Command Tutorial][cmd]. It's pretty simple. There are also several [Bubble Tea examples][examples] available and, of course, there are [Go Docs][docs]. -[cmd]: http://github.com/charmbracelet/bubbletea/tree/master/tutorials/commands/ -[examples]: http://github.com/charmbracelet/bubbletea/tree/master/examples +[cmd]: https://github.com/charmbracelet/bubbletea/tree/master/tutorials/commands/ +[examples]: https://github.com/charmbracelet/bubbletea/tree/master/examples [docs]: https://pkg.go.dev/github.com/charmbracelet/bubbletea?tab=doc ## Debugging @@ -358,7 +358,7 @@ welcome! See [contributing][contribute]. -[contribute]: http://github.com/charmbracelet/bubbletea/contribute +[contribute]: https://github.com/charmbracelet/bubbletea/contribute ## Feedback