Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
41 lines (30 loc) · 1.1 KB

CONTRIBUTING.md

File metadata and controls

41 lines (30 loc) · 1.1 KB

Contributing to UAE Public Data Engine

Thank you for your interest in contributing to the UAE Public Data Engine! We welcome contributions from everyone.

Getting Started

  1. Fork the repository on GitHub.
  2. Clone your fork locally.
  3. Install Dependencies: We use Poetry. 
    make install
  4. Create a Branch for your feature or bug fix: git checkout -b feature/my-feature.

Development Workflow

  1. Make your changes.
  2. Run the tests to ensure everything is working: 
    make test
  3. Run the linter to ensure code style compliance: 
    make lint
  4. Commit your changes using clear and descriptive commit messages.

Pull Requests

  1. Push your branch to your fork.
  2. Open a Pull Request against the main branch of this repository.
  3. Describe your changes and link to any relevant issues.

Code Style

  • We use Ruff for linting and formatting.
  • Please ensure your code passes make check before submitting.

License

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