Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
115 lines (83 loc) · 2.84 KB

CONTRIBUTING.md

File metadata and controls

115 lines (83 loc) · 2.84 KB

Contributing to Discovery-SearchUI

We welcome contributions! Please adhere to these guidelines to ensure seamless integration of your PRs. It is advisable to contact the Discovery team prior to commencing your development efforts. We are committed to providing comprehensive assistance. You may reach us by initiating an issue on this repository or writing an email to UAF-asf-discovery@alaska.edu.

Branch & PR Target

  • The base branch is test (default branch).
  • Always branch off of upstream/test and open PRs against test.

Local Setup

This is a quick outline for local setup. For detailed instructions, see the README.

  1. Fork & clone:

    git clone https://github.com/<your-username>/Discovery-SearchUI.git
cd Discovery-SearchUI
git remote add upstream https://github.com/asfadmin/Discovery-SearchUI.git
git fetch upstream
git checkout -b feat/short-description upstream/test

  2. Install dependencies:

    npm install

  3. Run dev server:

    npx ng serve

  4. If your feature depends on local domain or SSL:

    • Add 127.0.0.1 local.asf.alaska.edu to /etc/hosts
    • Install mkcert
    • Serve with HTTPS: 
      npx ng serve --host=local.asf.alaska.edu --ssl true --ssl-cert <cert-path> --ssl-key <key-path>
      For detailed instructions, see the README.

i18n (Required)

  • Do not hardcode user-facing text.

  • Use ngx-translate.

  • Add/modify translation keys in strings.json.

  • Reference in templates with the translate pipe, e.g.:

    <button>{{ 'SEARCH_BUTTON_APPLY' | translate }}</button>

  • List any new/changed keys in your PR description.

Tests, Lint, Build

Run before opening a PR:

npm run lint
npm test
npm run build

All must pass.

Commit Style

Use descriptive commit messages. Conventional Commit style is preferred:

  • feat(download-queue): add cancel button
  • fix(map): correct tile layer attribution
  • docs(readme): clarify HTTPS setup

Opening a PR

  • Target branch: test
  • Title: short and descriptive
  • Body:
    • What changed
    • Why
    • How tested
    • Screenshots if UI
    • i18n keys list (if applicable)
  • Check the checklist in the PR template.

Review & Merge

  • Maintainers will review for scope, coding style, and i18n compliance.
  • CI (lint, tests, build, CodeQL) must pass.
  • Merges use Squash & merge into test.
  • Deployments to shared environments are maintainers-only.

Thank you for contributing!