Skip to content

CONTRIBUTE.md

Latest commit

 

History

History
49 lines (32 loc) · 1.49 KB

CONTRIBUTE.md

File metadata and controls

49 lines (32 loc) · 1.49 KB

Contributing to Mirador Multi-User

Thank you for your interest in contributing to this project! Your help is essential to improve and maintain this codebase.

Getting Started

See README.md for installation steps. Easy issues are tagged as "Good_first_issue"

Code Style

  • Follow the existing code style and structure.
  • Write clear, concise, and commented code.
  • Format your code with Prettier or the project formatter.

Commit Messages

Follow the Conventional Commits style:

feat: add support for new IIIF manifest structure  
fix: correct bug in annotation display  
docs: update README with install instructions

Add "!" at the beginning of the commit message to indicate that the commit is a breaking change.

Pull Requests

  • Create a feature or fix branch (git checkout -b feat/my-feature).
  • Push to your fork and submit a pull request.
  • Link related issues if applicable.
  • Describe clearly what your PR does.

Issues

  • Check for existing issues before creating a new one.
  • Provide clear titles and steps to reproduce bugs.
  • Label your issue correctly (e.g., bug, enhancement, question).*
  • Use provided templates for issues when available.

Disclaimer

As any project, start has been a bit messy. Now, we have clear vision and know where we go. We have work a lot to structure and open the project and things are continuously improving.

Don't flee immediately, if you dig few ugly old code lines or rough PRs !