Quick Start
There are two ways to contribute to Who To Bother:Web Interface
Use the website’s contribution form to submit changes directly through your browser. This is the easiest way to contribute.
GitHub Workflow
Fork the repository and submit a pull request manually. This gives you more control over your changes.
What You Can Contribute
Adding a New Company
You can add any tech company that has a presence on X. Each company entry includes:- Company Information: Name, description, and logo
- Contact Categories: Logical groupings (e.g., Products, Engineering, Support)
- Contact Details: Product/role names and associated X handles
- Optional Links: Website, documentation, GitHub, Discord
Updating Existing Companies
You can update existing company entries to:- Add new contacts or categories
- Update outdated information
- Fix errors or typos
- Add optional company links
Contribution Guidelines
Only include public X handles of people who are comfortable being contacted. Never add personal contact information without permission.
Content Standards
Handles: Only include public Twitter/X handles of people who are comfortable being contacted about their company or product. Email Addresses: Only include publicly available email addresses (e.g., from company websites, public profiles, or with explicit permission). Accuracy: Ensure all information is accurate and up-to-date. Double-check handles and spellings. Organization: Group contacts logically by product, team, or functional area. Descriptions: Keep company descriptions concise and informative (1-2 sentences). Logos: Use SVG format when possible. Ensure logos are appropriately sized and themed for dark mode.What Not to Include
- Personal email addresses or phone numbers
- Private or protected social media accounts
- People who have requested not to be contacted
- Inaccurate or outdated information
- Promotional content or advertisements
How Contributions Work
Sign in with GitHub
Authenticate using your GitHub account. This allows the system to create pull requests on your behalf.
Automatic PR creation
The system automatically forks the repository (if needed), creates a branch, commits your changes, and opens a pull request.
File Structure
Understanding the repository structure helps if you want to contribute directly via GitHub:Company Data File
Each company has a JSON file insrc/data/companies/:
yourcompany.json
Logo Component
Logos are defined insrc/components/company-logos.tsx:
company-logos.tsx
Validation
All company data is validated against a Valibot schema to ensure data integrity:- Missing required fields (
id,name,description,logoType,categories) - Invalid handle format (must start with
@and contain only letters, numbers, and underscores) - Invalid email format
- Empty contacts or categories arrays
Testing Locally
Before submitting your changes, test them locally:Code of Conduct
When contributing to Who To Bother:- Be respectful and professional in all interactions
- Only add accurate information that you’ve verified
- Respect privacy - don’t add personal contact information without permission
- Focus on people who are actively engaged with the developer community
- Be patient - maintainers review PRs as time allows
- Be open to feedback - we may request changes to your contribution
Getting Help
If you have questions or need assistance:- Open an issue on GitHub
- Reach out on X to @thehungrybird_
- Check the documentation for detailed guides on authentication and submitting changes
Next Steps
Authentication
Learn how the GitHub OAuth authentication system works
Submit Changes
Step-by-step guide to submitting your first contribution