ogcincubator / ogcincubator/bblocks-docs

Naming conventions

Open
#4 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
JavaScript
Stars
1
Forks
4
PR merge metrics
No merged PRs in 30d

Description

We need naming conventions for:

  • Prefixes (ogc.x.y.z....)
  • Tree layout (how to arrange the bblocks inside _sources)
  • Path components and bblock ids (e.g., is it featureCollection, feature-collection or feature_collection? Right now we have examples of all of those)

Paging @rob-metalinkage @doublebyte1

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the existing examples in _sources, including the differing prefixes, tree layouts, path components, and bblock ids. Done means documenting one consistent convention for each area and resolving the featureCollection, feature-collection, and feature_collection alternatives.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.