Contributing to ServerlessInsight

We welcome contributions from the community! Here's how you can help make ServerlessInsight better.

How to Contribute

Report Bugs

If you find a bug, please create an issue on GitHub with:

• A clear, descriptive title
• Steps to reproduce the issue
• Expected behavior vs actual behavior
• Your environment details (OS, Node.js version, etc.)

Suggest Features

We'd love to hear your ideas! Please create an issue with:

• A clear description of the feature
• Use cases and examples
• Any relevant references or inspiration

Submit Code Changes

1. Fork the repository on GitHub
2. Create a branch from main:

   git checkout -b your-feature-branch

3. Make your changes following our coding standards
4. Test your changes thoroughly
5. Commit your changes with clear, descriptive messages
6. Push to your fork and submit a pull request

Improve Documentation

Documentation improvements are always welcome! This includes:

• Fixing typos or unclear language
• Adding examples
• Translating content to other languages
• Updating outdated information

Development Setup

1. Clone the repository:

   git clone https://github.com/geek-fun/serverlessinsight.git

2. Install dependencies:

   npm install

3. Run the documentation site locally:

   npm run docs:dev

Code Style

• Follow existing code patterns in the project
• Write clear, self-documenting code
• Add comments for complex logic
• Keep functions small and focused

Pull Request Guidelines

• Keep PRs focused on a single issue
• Write a clear title and description
• Reference any related issues
• Ensure all tests pass
• Update documentation if needed

Questions?

If you have questions about contributing, feel free to:

• Open an issue on GitHub
• Contact us at support@geekfun.club
• Reach out on Twitter @Blankll31075

Thank you for contributing to ServerlessInsight! 🎉