Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
97 lines (61 loc) · 2.21 KB

CONTRIBUTING.md

File metadata and controls

97 lines (61 loc) · 2.21 KB

Contributing to AI Pulse

Thank you for your interest in contributing to AI Pulse! We welcome contributions from the community to help improve this project.

🚀 How to Contribute

1. Fork the Repository

Click the "Fork" button at the top right of the repository page to create your own copy of the project.

2. Clone Your Fork

Clone the repository to your local machine:

git clone https://github.com/30tools/ai-pulse.git
cd ai-pulse

3. Install Dependencies

We use Bun as our preferred package manager, but you can also use npm.

bun install
# or
npm install

4. Create a New Branch

Create a new branch for your feature or bug fix:

git checkout -b feature/my-new-feature
# or
git checkout -b fix/bug-fix-name

5. Make Your Changes

Implement your changes. Make sure to follow the existing code style and conventions.

  • Framework: Next.js 16 (App Router)
  • Styling: Tailwind CSS 4
  • Formatting: Prettier (recommended)

6. Test Your Changes

Run the development server to verify your changes:

bun dev

Ensure everything looks and works as expected.

7. Commit Your Changes

Commit your changes with descriptive commit messages:

git add .
git commit -m "feat: add amazing new feature"

We follow the Conventional Commits specification.

8. Push to Your Fork

Push your branch to your forked repository:

git push origin feature/my-new-feature

9. Open a Pull Request

Go to the original repository and open a Pull Request (PR) from your forked branch. Provide a clear description of your changes and why they are necessary.

📝 Code Style Guidelines

  • Use TypeScript for all new components and logic.
  • Use functional components with React hooks.
  • Keep components small and reusable.
  • Use Tailwind CSS for styling. Avoid custom CSS files unless necessary.
  • Ensure your code is clean and readable.

🐛 Reporting Bugs

If you find a bug, please open an issue in the repository with details on how to reproduce it.

✨ Feature Requests

Have an idea for a new feature? Open an issue or start a discussion to share your thoughts!

Thank you for contributing! 🎉