🤝 Contributing to gh.gg

We welcome and appreciate all contributions to gh.gg! Whether you're fixing a bug, adding a new feature, improving documentation, or just providing feedback, your help makes this project better. This guide outlines the steps and best practices for contributing to gh.gg.

🚀 How to Contribute

The contribution process is designed to be straightforward and collaborative:

1. Fork the Repository Start by forking the lantos1618/github.gg repository on GitHub. This creates a personal copy of the project under your GitHub account where you can freely make changes.

2. Create a Feature Branch Before making any changes, create a new branch from main for your feature or bug fix. Use a descriptive name for your branch, such as feature/add-new-dashboard or bugfix/fix-pr-review-crash.

3. Make Your Changes Implement your changes in your new branch. While working, keep the following in mind:

   • Write Tests: For new features, always include corresponding tests. If fixing a bug, add a test that reproduces the bug, then ensure your fix makes it pass.
   • Follow Code Style: Adhere to the existing TypeScript and React code style patterns. We use ESLint and Prettier to help enforce this.
   • Update Documentation: If your changes affect how a feature works, add new features, or introduce new APIs, update the relevant documentation. This includes comments, READMEs, or any dedicated wiki pages.
   • Maintain Type Safety: Strive for 100% TypeScript coverage to ensure code robustness.

4. Commit Your Changes Commit your changes with clear and concise messages. We follow the Conventional Commits↗ specification for commit messages. This helps with automatic changelog generation and understanding the project history. Example:

   Or for a bug fix:

5. Push to Your Fork Push your local changes to your forked repository on GitHub.

6. Open a Pull Request (PR) Once your changes are ready and pushed, open a Pull Request from your feature branch to the main branch of the original lantos1618/github.gg repository.

   • Provide a clear title and description for your PR.
   • Reference any related issues (e.g., Closes #123).
   • Explain the problem your PR solves and how it addresses it.
   • Include screenshots or GIFs for UI changes if applicable.

🛠️ Development Guidelines

To ensure consistency and quality across the codebase, please follow these guidelines:

• Code Style: Maintain the existing TypeScript and React patterns. Use the provided linting and formatting tools.
• Testing: Write comprehensive tests for new features and bug fixes. You can run tests using bun test.
• Type Safety: Leverage TypeScript to its fullest. New code should maintain 100% TypeScript coverage.
• Documentation: Update README.md, inline code comments, and any relevant docs/ files for changes in functionality or APIs.
• Commits: Use Conventional Commits↗ for all your commit messages. This standardizes commit history and facilitates automated tools.

🆘 Areas We Need Help

We have many exciting ideas and a growing list of tasks. Here are some areas where your contributions would be particularly impactful:

• 🎨 UI/UX Improvements: Help us refine the user interface and enhance the overall user experience.
• 📝 Documentation and Tutorials: Create new guides, improve existing ones, or write tutorials for specific features.
• 🐛 Bug Fixes and Testing: Help identify, reproduce, and fix bugs, and expand our test coverage.
• 🌍 Internationalization (i18n): Assist in making gh.gg accessible to a global audience.
• ⚡ Performance Optimizations: Identify and resolve performance bottlenecks to make gh.gg faster and more efficient.
• 🔌 New Integrations and Features: Contribute to the development of new AI models, GitHub integrations, or other innovative features mentioned in our Roadmap↗.

🙏 Get Started!

We're excited to see your contributions! The easiest way to get started is to check out the open issues↗ marked with good first issue or help wanted. Don't hesitate to ask questions or discuss your ideas in the issues or discussions tab.

Thank you for being a part of the gh.gg community!