Skip to content

Commit 417e829

Browse files
authored
Merge pull request OpenSource-Communities#83 from chris-nowicki/AlphabetizeGlossary
Alphabatize glossary and add instructions to contributing guide.
2 parents 991276b + 092a97c commit 417e829

File tree

2 files changed

+36
-34
lines changed

2 files changed

+36
-34
lines changed

10-glossary.md

Lines changed: 32 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -1,71 +1,71 @@
1-
## Repository
2-
3-
A repository is a central location where code is stored and managed. In open source, repositories are often hosted on platforms like GitHub, GitLab, or Bitbucket. Each repository can contain one or more projects, and contributors can submit changes to the code by making pull requests.
4-
5-
## Maintainer
1+
## Branch
62

7-
A maintainer is a person or a group of people responsible for maintaining a specific open-source project. Maintainers are typically responsible for reviewing and accepting or rejecting contributions from other contributors. They also have the authority to make final decisions about the direction and scope of the project.
3+
A branch is a separate version of the code that's created for development purposes. Branches allow contributors to experiment with changes without affecting the main codebase. When changes are ready to be merged into the main codebase, they're typically submitted as a pull request.
84

9-
## Core Member
5+
## Bug
106

11-
A core member is a contributor who has been granted additional privileges or responsibilities within an open-source project. Core members are typically trusted contributors who have demonstrated a deep understanding of the project and have made significant contributions to its development.
7+
A bug refers to an error, flaw, or defect in code that adversely affects the proper functioning of the software. Open-source projects often depend on contributions from the community to identify and rectify these bugs.
128

13-
## Issue
9+
## Clone
1410

15-
An issue is a problem or bug that needs to be addressed in the code. Issues can be created by anyone, and they're often used to keep track of bugs, feature requests, and other tasks that need to be done.
11+
Cloning is the process used to copy an existing Git repository into a new local directory. The `git clone` command will create a new local directory for the repository, copy all the contents of the specified repository, create the remote tracked branches, and checkout an initial branch locally. By default, Git clone will create a reference to the remote repository called origin.
1612

1713
## Contributor
1814

1915
A contributor is anyone who makes changes, additions, or suggestions to an open source project. Contributors can be developers, designers, writers, testers, or anyone else who helps to make the project better.
2016

21-
## Clone
17+
## Core Member
2218

23-
Cloning is the process used to copy an existing Git repository into a new local directory. The `git clone` command will create a new local directory for the repository, copy all the contents of the specified repository, create the remote tracked branches, and checkout an initial branch locally. By default, Git clone will create a reference to the remote repository called origin.
19+
A core member is a contributor who has been granted additional privileges or responsibilities within an open-source project. Core members are typically trusted contributors who have demonstrated a deep understanding of the project and have made significant contributions to its development.
20+
21+
## Docs
22+
23+
This is an abbreviation for the word documentation. Its primary use is to explain how to implement and use the product. Documentation also provides people with information on how to contribute to OSS projects and expectations for contributors. Markdown, a text-based coding language is often used to create these forms of content. Want to see one in action? Check out the [Style Guide in our Pizza Verse repo](https://github.com/open-sauced/pizza-verse/blob/main/style-guide.md)!
2424

2525
## Fork
2626

2727
A fork is a copy of a repository. When you fork a repository, you create a new copy of the codebase that you can modify and experiment with without affecting the original codebase.
2828

29-
## Branch
29+
## Issue
3030

31-
A branch is a separate version of the code that's created for development purposes. Branches allow contributors to experiment with changes without affecting the main codebase. When changes are ready to be merged into the main codebase, they're typically submitted as a pull request.
31+
An issue is a problem or bug that needs to be addressed in the code. Issues can be created by anyone, and they're often used to keep track of bugs, feature requests, and other tasks that need to be done.
3232

33-
## Pull Request
33+
## Maintainer
3434

35-
A pull request is a request from a contributor to a maintainer for changes made to the code to be pulled into a codebase.
35+
A maintainer is a person or a group of people responsible for maintaining a specific open-source project. Maintainers are typically responsible for reviewing and accepting or rejecting contributions from other contributors. They also have the authority to make final decisions about the direction and scope of the project.
36+
37+
## Markdown
38+
39+
Markdown is a lightweight markup language commonly used for creating formatted text documents. It is widely used for creating documentation and README files in software development due to its simplicity and readability.
3640

3741
## Merge
3842

3943
Merging is the process of combining changes from one branch into another. When a pull request is accepted and merged, the changes made in the pull request become part of the main codebase.
4044

41-
## Docs
45+
## Onboarding
4246

43-
This is an abbreviation for the word documentation. Its primary use is to explain how to implement and use the product. Documentation also provides people with information on how to contribute to OSS projects and expectations for contributors. Markdown, a text-based coding language is often used to create these forms of content. Want to see one in action? Check out the [Style Guide in our Pizza Verse repo](https://github.com/open-sauced/pizza-verse/blob/main/style-guide.md)!
47+
Onboarding documentation helps new team members or collaborators quickly become familiar with a project's structure, goals, and processes.
4448

45-
## Bug
49+
## OSS Projects
4650

47-
A bug refers to an error, flaw, or defect in code that adversely affects the proper functioning of the software. Open-source projects often depend on contributions from the community to identify and rectify these bugs.
51+
OSS stands for "Open-Source Software" projects. These are software projects where the source code is made available to the public, allowing anyone to view, use and modify the software.
52+
53+
## Pull Request
54+
55+
A pull request is a request from a contributor to a maintainer for changes made to the code to be pulled into a codebase.
4856

4957
## Quality Assurance
5058

5159
Quality assurance in open-source projects involves testing, reviewing, and ensuring the software meets the desired standards. Community members often contribute to testing and reporting issues to improve the software's quality.
5260

53-
## OSS Projects
61+
## Release Notes
5462

55-
OSS stands for "Open-Source Software" projects. These are software projects where the source code is made available to the public, allowing anyone to view, use and modify the software.
63+
Release notes are documents that detail changes, enhancements, bug fixes, and new features in each software release. They inform users and stakeholders about what to expect in a new version of the software.
5664

57-
## Markdown
65+
## Repository
5866

59-
Markdown is a lightweight markup language commonly used for creating formatted text documents. It is widely used for creating documentation and README files in software development due to its simplicity and readability.
67+
A repository is a central location where code is stored and managed. In open source, repositories are often hosted on platforms like GitHub, GitLab, or Bitbucket. Each repository can contain one or more projects, and contributors can submit changes to the code by making pull requests.
6068

6169
## Style Guide
6270

6371
A style guide is a set of rules and conventions that define the preferred formatting, writing style, and visual elements used in documentation and other content. This helps maintain consistency and clarity across documents, making them easier to read and understand.
64-
65-
## Onboarding
66-
67-
Onboarding documentation helps new team members or collaborators quickly become familiar with a project's structure, goals, and processes.
68-
69-
## Release Notes
70-
71-
Release notes are documents that detail changes, enhancements, bug fixes, and new features in each software release. They inform users and stakeholders about what to expect in a new version of the software.

CONTRIBUTING.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -94,9 +94,11 @@ To include a link, highlight the text, then press ctrl + K and enter the URL. Fo
9494
```bash
9595
click [here](Github.com)
9696
```
97-
5. **Testing Your Changes**: Before finalizing your new section, it's advisable to test your changes locally. You can build or render the documentation to ensure your new section appears as expected within the documentation structure.
97+
> NOTE: If adding definitions to the `10-glossary.md` section ensure definitions are added in alphabetical order.
9898
99-
6. **Updating the Sidebar**: Adding the file to the sidebar is necessary for the user to discover the content.
99+
1. **Testing Your Changes**: Before finalizing your new section, it's advisable to test your changes locally. You can build or render the documentation to ensure your new section appears as expected within the documentation structure.
100+
101+
2. **Updating the Sidebar**: Adding the file to the sidebar is necessary for the user to discover the content.
100102

101103
Contributors must add a new chapter to the sidebar.
102104

0 commit comments

Comments
 (0)