Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
79 lines (63 loc) · 2.35 KB

CONTRIBUTING.md

File metadata and controls

79 lines (63 loc) · 2.35 KB
Raw

Contributing to Pulse Analytics

Thank you for your interest in contributing to Pulse! We welcome contributions from the community to help make privacy-first analytics better for everyone.

Getting Started

  1. Fork the repository on GitHub.
  2. Clone your fork locally: 
    git clone https://github.com/YOUR_USERNAME/pulse.git
cd pulse
  3. Install dependencies: 
    npm install
  4. Set up environment variables: Copy .env.example (if available) or create .env.local with the following: 
    NEXT_PUBLIC_API_URL=http://localhost:8082
NEXT_PUBLIC_AUTH_URL=http://localhost:3000
NEXT_PUBLIC_AUTH_API_URL=http://localhost:8081
NEXT_PUBLIC_APP_URL=http://localhost:3003
  5. Run the development server: 
    npm run dev

Development Workflow

  1. Create a new branch for your feature or fix: 
    git checkout -b feature/my-new-feature
  2. Make your changes.
  3. Lint and Type Check: Before committing, ensure your code passes our quality checks: 
    npm run lint
npm run type-check
  4. Commit your changes with a descriptive message.
  5. Push to your fork and submit a Pull Request.

Code Style

  • We use Next.js with TypeScript.
  • Styling is done with Tailwind CSS.
  • Please follow the existing code style and conventions found in the project.
  • Ensure all new components are responsive and support dark mode.

Pull Request Guidelines

  • Provide a clear description of what your PR does.
  • Link to any relevant issues.
  • Ensure all checks pass (linting, type checking).
  • If you are adding a new feature, please include screenshots or a video if applicable.

Developer Certificate of Origin

All contributions must be signed off under the Developer Certificate of Origin (DCO). By signing off, you certify that you wrote the contribution or otherwise have the right to submit it under this repository's license.

Sign off every commit:

git commit -s

This adds a Signed-off-by: Your Name <your@email> trailer to the commit message. Pull requests containing commits without a sign-off cannot be accepted.

License

By contributing to Pulse, you agree that your contributions will be licensed under the AGPL-3.0 License.