Skip to content

Commit

Permalink
Added project and repository definitions to Glossary (#697)
Browse files Browse the repository at this point in the history
* Added project and repository definitions to Glossary

Following an actions from an ISPO WG meeting in May 2024, I have added definitions for project and repository to the Glossary. I re-ordered the existing entries to make them alphabetical.

* Integrating the glossary into the book, hoping that it will just work :)

---------

Co-authored-by: Sebastian Spier <[email protected]>
  • Loading branch information
claredillon and spier authored Jun 24, 2024
1 parent a71649f commit d21f5cd
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 1 deletion.
1 change: 1 addition & 0 deletions book/en/toc_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ Instead edit toc_template.md
## Appendix

* [Pattern Template](../../meta/pattern-template.md)
* [Glossary](../../meta/glossary.md)
* Extras
* [README Template](../../patterns/2-structured/templates/README-template.md)
* [CONTRIBUTING Template](../../patterns/2-structured/templates/CONTRIBUTING-template.md)
Expand Down
4 changes: 3 additions & 1 deletion meta/glossary.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,9 @@ This glossary defines essential terms that are commonly used when writing new pa

Through this the glossary helps members of the Patterns Working Group to use consistent language when writing and reviewing patterns.

- **organization** - An umbrella for multiple legal entities. (synonyms: group, enterprise) (e.g. Lufthansa)
- **legal entity** - An entity that has its own legal rights and obligations (synonyms: company, subsidiary) (e.g. Lufthansa Systems GmbH, Lufthansa Industry Solutions TS GmbH, ...)
- **organization** - An umbrella for multiple legal entities. (synonyms: group, enterprise) (e.g. Lufthansa)
- **project** - Projects serve as a planning and tracking tool that can integrate with the issues and pull requests within one or more repositories. In [GitHub documentation](https://docs.github.com/en/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects), projects are described as an adaptable spreadsheet, task-board, and road map that integrates with your issues and pull requests to help you plan and track your work effectively. A single project can include items (e.g. issues and pull requests) from multiple repositories.
- **repository** - A repository is a central location for source code, files, where each file's revision history is stored and managed. It enables version control and collaboration among multiple contributors. Repositories are designed to facilitate collaboration, discussion, and management of work through features like issues, pull requests, and project boards. A single repository can be associated with multiple projects.

*Note that his glossary is far from complete. If you see terms that are used frequently in our patterns and should be defined in this glossary, please add them.*

0 comments on commit d21f5cd

Please sign in to comment.