Skip to content

Latest commit

 

History

History
43 lines (30 loc) · 1.71 KB

CONTRIBUTING.md

File metadata and controls

43 lines (30 loc) · 1.71 KB

Contributing to the Project

Thank you for considering contributing to this project! We appreciate your help and support.

How to Contribute

  1. Fork the repository: Create your own fork of the repository.
  2. Clone your fork: Clone your forked repository to your local machine.
  3. Create a new branch: Create a new branch for your feature or bug fix.
  4. Make changes: Implement your changes in the new branch.
  5. Commit your changes: Commit your changes with a clear message.
  6. Push to your fork: Push your changes back to your forked repository.
  7. Submit a pull request: Go to the original repository and submit a pull request.

Configuration Setup

To set up the configuration for this project, please refer to the example files available in the temp directory. You can find:

  • .env: This file contains environment variables needed for the application.
  • config.yml: This file contains configuration settings for the application.

Make sure to create your own versions of these files based on the examples provided.

Coding Standards

  • Follow the existing code style and conventions used in the project.
  • Write clear and descriptive commit messages.
  • Ensure your code is well-documented.

Submitting Issues

If you encounter any bugs or have feature requests, please submit an issue in the repository. Please provide as much detail as possible, including:

  • Steps to reproduce the issue
  • Expected behavior
  • Actual behavior

Submitting Pull Requests

When submitting a pull request, please ensure that:

  • Your code is well-tested.
  • You have followed the coding standards outlined above.
  • You provide a clear description of what your pull request does.

Thank you for your contributions!