Skip to content

Latest commit

 

History

History
79 lines (55 loc) · 2.92 KB

CONTRIBUTING.md

File metadata and controls

79 lines (55 loc) · 2.92 KB

Contribution Guidelines

Thank you for considering contributing to our project! Your contributions are invaluable in helping us improve and grow. Please take a moment to review the following guidelines before you start.

Table of Contents

Code of Conduct

This project adheres to the Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to [email protected].

How to Contribute

  1. Fork the repository.
  2. Create a feature branch (git checkout -b feature/your-feature-name).
  3. Commit your changes (git commit -m 'Add some feature').
  4. Push to the branch (git push origin feature/your-feature-name).
  5. Open a Pull Request.

For significant changes, please open an issue first to discuss your ideas.

Reporting Issues

If you encounter a bug, glitch, or something that isn't working as expected, please file an issue. Ensure your issue includes:

  • A descriptive title.
  • Steps to reproduce the problem.
  • The expected behavior.
  • The actual behavior.
  • Relevant screenshots or error messages (if applicable).

Suggesting Enhancements

We welcome suggestions to improve the project. When suggesting enhancements:

  • Explain your idea clearly.
  • Describe the problem your suggestion solves.
  • Include any examples, mockups, or references to help us understand your proposal.

Submitting Pull Requests

Pull Requests (PRs) are the best way to contribute code changes. Before submitting a PR:

  • Ensure your code adheres to the Style Guidelines.
  • Write or update tests if applicable.
  • Verify that all tests pass locally.
  • Include a descriptive PR title and summary.

Pull Request Checklist

  • Does your PR address an open issue? Link it in the description.
  • Have you added/updated necessary documentation?
  • Have you tested your changes locally?
  • Are your commits properly formatted and descriptive?

Style Guidelines

Follow the established coding style in the project. Here are a few general guidelines:

  • Use clear, self-explanatory variable and function names.
  • Write concise and meaningful commit messages.
  • Adhere to the project's linting and formatting rules.

Development Setup

To set up your development environment:

  1. Clone the repository: git clone https://github.com/your-repo.git.
  2. Navigate to the project directory: cd your-repo.
  3. Install dependencies: npm install (or the relevant command for your stack).
  4. Run npm dev to run the local development server.
  5. Run tests to verify your setup: npm test (or the relevant command).

Thank you for your contributions!