Skip to content

Latest commit

 

History

History
61 lines (39 loc) · 2.5 KB

CONTRIBUTION.md

File metadata and controls

61 lines (39 loc) · 2.5 KB

Contributing to GeniX

Thank you for your interest in contributing to GeniX! We welcome all contributions, whether they are code improvements, bug fixes, documentation updates, or other forms of help.

Before contributing, please take a moment to review the following guidelines.

Code of Conduct

This project adheres to the Contributor Covenant Code of Conduct. By participating, you are expected to uphold this code.

How Can I Contribute?

Reporting Bugs

If you find a bug, please report it by opening an issue. When submitting a bug report, please include as much detail as possible to help us understand and reproduce the issue. Some useful information might include:

  • Steps to reproduce the issue
  • Expected behavior
  • Actual behavior
  • Your environment (operating system, Node.js version, etc.)

Suggesting Features or Improvements

We're open to new ideas! If you have suggestions for new features or ways to improve the project, please open an issue and describe your idea in detail. When making feature requests, consider the following:

  • Explain why the feature would be useful for others.
  • Suggest ways to implement it, if possible.

Pull Requests

If you'd like to contribute code, here’s how you can get started:

  1. Fork the repository.
  2. Clone your fork and set up the project locally.
  3. Create a new branch for your feature or fix.
  4. Make your changes in that branch.
  5. Ensure that your code follows the project's coding style (see below).
  6. Write or update tests if applicable.
  7. Commit and push your changes.
  8. Submit a pull request with a clear description of what you've done.

Coding Style

  • Follow the existing code style where possible.
  • Use meaningful variable and function names.
  • Keep code simple and readable.

We also recommend using Prettier and ESLint to format and lint your code.

Testing

Ensure that your code passes all existing tests, and write new tests for any new functionality you introduce. You can run the tests with:

npm test

Make sure all tests pass before submitting a pull request.

Documentation

We appreciate contributions to our documentation. If your pull request changes how the project works or adds new functionality, please update the relevant sections of the documentation accordingly.

License

By contributing, you agree that your contributions will be licensed under the MIT License.