Skip to content

Latest commit

 

History

History
53 lines (38 loc) · 1.98 KB

CONTRIBUTING.md

File metadata and controls

53 lines (38 loc) · 1.98 KB

Contributing to Zyflo

We welcome contributions from the community! Whether it's bug reports, feature requests, or pull requests, your contributions are greatly appreciated.

How to Contribute

Reporting Bugs

If you find a bug, please open an issue on our GitHub repository with the following information:

  • A clear and descriptive title.
  • A detailed description of the issue.
  • Steps to reproduce the issue.
  • Any relevant code snippets or screenshots.

Suggesting Enhancements

If you have an idea for a new feature or an improvement, please open an issue on our GitHub repository with the following information:

  • A clear and descriptive title.
  • A detailed description of the enhancement.
  • Any relevant code snippets or mockups.

Submitting Pull Requests

If you would like to contribute code, please follow these steps:

  1. Fork the repository.
  2. Create a new branch for your feature or bug fix:
    git checkout -b feature/your-feature-name
  3. Make your changes.
  4. Commit your changes with a clear and descriptive commit message:
    git commit -m "Add feature: your feature name"
  5. Push your changes to your forked repository:
    git push origin feature/your-feature-name
  6. Open a pull request on our GitHub repository with the following information:
    • A clear and descriptive title.
    • A detailed description of the changes.
    • Any relevant code snippets or screenshots.

Code Style

Please ensure that your code follows our coding standards and style guidelines. We use ESLint and Prettier to enforce code quality and consistency.

Documentation

If you are adding a new feature or making changes to existing functionality, please update the relevant documentation in the docs directory.