Skip to content

Latest commit

 

History

2 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 

Repository files navigation

Contributing to This Project

Thank you for considering contributing to this project! We welcome contributions of all kinds. Please take a moment to review the guidelines below.

How to Contribute

  1. Fork the Repository
    Create a fork of this repository to make your changes.

  2. Clone Your Fork
    Clone your forked repository to your local machine:

    git clone https://github.com/your-username/your-repository-name.git
  3. Create a Branch
    Create a new branch for your feature or bug fix:

    git checkout -b feature-or-bugfix-name
  4. Make Changes
    Implement your changes and ensure your code adheres to the project's coding standards.

  5. Test Your Changes
    Run tests (if there are any) to ensure your changes work as expected:

    npm test
  6. Commit Your Changes
    Write clear and concise commit messages:

    git commit -m "<type>(optional scope): <description>"

Semantic Commit Messages

Please use semantic commit messages to describe your changes. This helps maintain a clear and structured commit history. The format is as follows:

<type>(optional scope): <description>
[optional body]

Common types include:

  • feat: A new feature
  • fix: A bug fix or error correction in the code
  • hotfix: A quick and urgent fix
  • docs: Documentation changes
  • style: Code style changes (spaces, formatting, etc.)
  • refactor: Code refactoring without adding features or fixing bugs
  • test: Adding or updating tests
  • chore: Maintenance tasks (e.g., updating build scripts)
  • build: Changes to the build system or dependencies
  • ci: Changes to CI configuration or scripts
  • cleanup: Code cleanup
  • lint: Code linting fixes
  • remove: Removal of code, files, or functionality
  • perf: Performance improvements
  • revert: Reverting a previous commit
  1. Push Your Changes
    Push your branch to your forked repository:

    git push origin feature-or-bugfix-name
  2. Open a Pull Request
    Open a pull request to the main repository. Provide a detailed description of your changes.

Reporting Issues

If you encounter any issues, please report them by opening an issue in the repository. Provide as much detail as possible to help us address the problem.

Additional Notes

  • Follow the existing code style and conventions.
  • Ensure your changes do not introduce new linting errors or warnings.

Thank you for contributing! Seed on!

About

No description, website, or topics provided.

Contributing

Stars

0 stars

Watchers

1 watching

Forks

Releases

Packages

Contributors