Contributing to Notiq

First off, thanks for taking the time to contribute! ❤️

All types of contributions are encouraged and valued. Please read the sections below to get started.

Table of Contents

• Code of Conduct
• I Have a Question
• I Want To Contribute
• Your First Code Contribution
• Styleguides

Code of Conduct

This project is governed by our Code of Conduct. By participating, you are expected to uphold this code.

I Have a Question

Before you ask a question, it is best to search for existing Issues. If you still need clarification, feel free to open a new one.

I Want To Contribute

Reporting Bugs

Use GitHub issues to track bugs and errors. Please provide as much context as possible, including reproduction steps and your environment (OS, browser, etc.).

Suggesting Enhancements

Enhancement suggestions are tracked as GitHub issues. Explain the current behavior, the expected behavior, and why this would be useful to most users.

Your First Code Contribution

1. Fork the project.
2. Clone your fork: git clone https://github.com/chinonsochikelue/notiq.git
3. Install dependencies: pnpm install
4. Create your feature branch: git checkout -b feature/AmazingFeature
5. Commit your changes using our Commit Message Styleguide.
6. Push and open a Pull Request.

Styleguides

Commit Messages

• Use the present tense ("Add feature" not "Added feature").
• Use the imperative mood ("Move cursor to..." not "Moves cursor to...").
• Limit the first line to 72 characters or less.
• Reference issues and PRs liberally.