Skip to content

Latest commit

 

History

History
53 lines (38 loc) · 1.8 KB

CONTRIBUTING.md

File metadata and controls

53 lines (38 loc) · 1.8 KB

Contributing to GenieWizards Finance Management API

We welcome contributions to improve this project. To help us maintain the quality and consistency of contributions, please follow these guidelines.

How to Contribute

Reporting Issues

  1. Check if the issue has already been reported.
  2. If not, create a new issue with the following details:
    • A clear and descriptive title.
    • A detailed description of the issue.
    • Steps to reproduce the issue, if applicable.
    • Any relevant logs or screenshots.

Suggesting Enhancements

  1. Check if the enhancement has already been suggested.
  2. If not, create a new issue with the following details:
    • A clear and descriptive title.
    • A detailed description of the enhancement.
    • Any relevant examples or mockups.

Submitting Code Changes

  1. Fork the repository.
  2. Create a new branch for your changes (e.g., feat/new-feature).
  3. Make your changes following the coding guidelines.
  4. Ensure your changes do not break existing tests.
  5. Submit a pull request with the following details:
    • A clear and descriptive title.
    • A detailed description of the changes.
    • Any relevant issue numbers.

Coding Guidelines

  • Follow the existing code style and conventions.
  • Write clear and concise commit messages.
  • Include comments and documentation where necessary.
  • Ensure your code is tested and passes all tests.

Setting Up the Development Environment

  1. Clone the repository.
  2. Install the required dependencies.
  3. Set up the environment variables as per the documentation.
  4. Run the development server and ensure everything is working correctly.

Code of Conduct

Please adhere to the Code of Conduct to foster a welcoming and inclusive community.

Thank you for contributing to the GenieWizards Finance Management API!