mapstruct / mapstruct/mapstruct.org

Add development glossary

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

Nobody has claimed this yet.

Dominant language
CSS
Stars
71
Forks
40
PR merge metrics
No merged PRs in 30d

Description

I think that it would be nice to have a development glossary on our website in order to ease the contribution process. With this "glossary" we can shortly write what each of our terms mean.

This is just an idea that is open for discussion 😄

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

The issue only proposes a development glossary for the website and does not identify files, terms, or a page location. First define the glossary’s scope and placement with maintainers; done means an agreed set of terms is published and accessible on the website.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.