You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+27-9Lines changed: 27 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,8 +1,10 @@
1
1
# Contributing to BetterBugs Development Tools
2
2
3
-
Thank you for your interest in contributing to our project. We welcome contributions of all kinds including bug reports, feature suggestions, documentation improvements, and code contributions. Your feedback and support help make this project better for everyone.
3
+
Thank you for your interest in contributing! We're building 175+ developer tools with a community-first mindset. We welcome contributions of all kinds: bug reports, feature suggestions, documentation improvements, new tools, and code contributions.
4
4
5
-
Please read through this document before submitting any issues or pull requests to ensure we have the necessary information to respond effectively.
5
+
**Our philosophy:** Low friction > perfection. We can refine things later. It's much harder to revive an abandoned repo.
6
+
7
+
Please read through this document before submitting any issues or pull requests. For detailed guides on tool structure, offline support, and more, visit the [Contributing Guides](https://docs.betterbugs.io/contributing-to-betterbugs).
6
8
7
9
## Reporting Bugs and Issues
8
10
@@ -16,14 +18,16 @@ Before reporting a bug, please check our [open issues](https://github.com/better
16
18
- Environment information (browser, OS, Node.js version)
17
19
- Screenshots or error messages if applicable
18
20
19
-
## Suggesting Enhancements
21
+
## Suggesting Enhancements and New Tools
20
22
21
-
We welcome ideas for improvements and new tools. Please [create a new issue](https://github.com/betterbugs/dev-tools/issues/new/choose)with your suggestion and include:
23
+
We welcome ideas for improvements and new tools. There's no permission needed—if you have an idea, build it! Please [create an issue](https://github.com/betterbugs/dev-tools/issues/new/choose)or [discussion](https://github.com/betterbugs/dev-tools/discussions) with:
22
24
23
-
- A clear description of the enhancement
25
+
- A clear description of the enhancement or tool
24
26
- Why this would be useful
25
27
- Any relevant examples or use cases
26
28
29
+
**Note:** If your tool uses APIs or network features, that's fine! Just make it optional and gracefully handle missing connectivity. See [Contributing Guides](https://docs.betterbugs.io/contributing-to-betterbugs) for details.
30
+
27
31
## Self Assigning Issues
28
32
29
33
To express interest in working on an issue, simply comment on it to let us know. Maintainers will assign it to you or discuss next steps if needed.
@@ -33,12 +37,14 @@ To express interest in working on an issue, simply comment on it to let us know.
33
37
Please ensure your pull request adheres to the following guidelines:
34
38
35
39
- Search [open pull requests](https://github.com/betterbugs/dev-tools/pulls) to ensure your change hasn't already been submitted
36
-
- Target the `develop` branch with your pull request
40
+
- Target the `develop` branch with your pull request (not `main`)
37
41
- Rebase your branch with the latest changes from `develop` before opening your PR
38
42
- Follow the existing code style and conventions
39
-
- Test your changes locally before submitting
43
+
- Test your changes locally: `npm run dev` and `npm run lint`
40
44
- Use TypeScript for all new code
41
45
46
+
**Adding a new tool?** Check the [Feature and Module Structure](https://docs.betterbugs.io/contributing-to-betterbugs) guide for detailed walkthrough and examples.
47
+
42
48
## Commit Messages
43
49
44
50
This project follows [Conventional Commits](https://www.conventionalcommits.org/). Please use one of the following commit types:
@@ -75,17 +81,29 @@ Test your changes locally before submitting a pull request:
75
81
- Test on different browsers (Chrome, Firefox, Safari, Edge)
76
82
- Test responsive design on mobile, tablet, and desktop viewports
77
83
- Verify accessibility where applicable
84
+
-**For offline-safe tools:** Test offline mode by running `npm run build && npm start`, then enabling offline in DevTools. See [PWA and Offline Behavior](https://docs.betterbugs.io/contributing-to-betterbugs) for details.
85
+
-**For tools with APIs:** Verify graceful failure when the API is unavailable
78
86
79
87
## Documentation
80
88
81
89
We love documentation contributions! Whether it's more complete descriptions, new examples, or better formatting, any help improving the documentation is appreciated.
82
90
91
+
## The Only Hard Rule
92
+
93
+
🚫 **Don't:** Require user login, store personal data, or collect user information.
94
+
95
+
✅ **Everything else is negotiable:** Network features, APIs, AI integrations—all welcome if implemented thoughtfully.
96
+
97
+
This keeps us legally sound and makes contributing stress-free.
98
+
83
99
## Community
84
100
85
101
Join us on [Discord](https://discord.com/invite/HF8XjwVtPh) to connect with the community and core team. Please be respectful and follow our [Code of Conduct](CODE_OF_CONDUCT.md).
86
102
103
+
**For detailed guides** on tool structure, offline support, contributing philosophy, and more, visit [Contributing Guides](https://docs.betterbugs.io/contributing-to-betterbugs).
104
+
87
105
## Questions?
88
106
89
-
For questions or concerns, please reach out to us at dev@betterbugs.io.
107
+
For questions or concerns, please reach out to us at dev@betterbugs.io or ask in our [Discord community](https://discord.com/invite/HF8XjwVtPh).
90
108
91
-
Thank you for your interest and contributions to BetterBugs🪲.
109
+
Thank you for your interest and contributions to BetterBugs 🪲
Copy file name to clipboardExpand all lines: README.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -49,7 +49,7 @@ With BetterBugs, debugging stops being guesswork and becomes a shared, reliable
49
49
50
50
## BetterBugs Development Tools
51
51
52
-
This repository contains our free, open-source development utilities—a comprehensive collection of 40+ tools designed to accelerate your development workflow. From text conversion and code formatting to data transformation and validation, our tools eliminate repetitive tasks and help you focus on what matters—building great software.
52
+
This repository contains our free, open-source development utilities—a comprehensive collection of 175+ tools designed to accelerate your development workflow. From text conversion and code formatting to data transformation and validation, our tools eliminate repetitive tasks and help you focus on what matters—building great software.
53
53
54
54
Built with modern technologies and designed for developers, by developers.
55
55
@@ -71,7 +71,7 @@ This leads to lost time and frustration when you just need to convert a format o
71
71
72
72
BetterBugs Development Tools solves this by providing:
73
73
74
-
-**40+ Tools in One Place**: Everything you need without switching between websites.
74
+
-**175+ Tools in One Place**: Everything you need without switching between websites.
75
75
-**Instant Conversions**: No waiting, no network delays. Real-time results.
76
76
-**Offline Support**: Works perfectly without internet thanks to PWA technology.
77
77
-**Built for Speed**: Optimized performance with Next.js and modern architecture.
@@ -80,7 +80,7 @@ BetterBugs Development Tools solves this by providing:
80
80
81
81
## Features
82
82
83
-
-**40+ Development Tools**: Text manipulation, code formatting, validation, generation, conversion, and more
83
+
-**175+ Development Tools**: Text manipulation, code formatting, validation, generation, conversion, and more
84
84
-**Modern Stack**: Built with Next.js 14, React 18, TypeScript, and Tailwind CSS
85
85
-**Fast & Responsive**: Optimized performance with server-side rendering and instant feedback
86
86
-**PWA Support**: Progressive Web App capabilities for offline access
0 commit comments