Skip to content

Commit 1381790

Browse files
committed
Fixed some syntax
1 parent 764c4e0 commit 1381790

File tree

2 files changed

+17
-12
lines changed

2 files changed

+17
-12
lines changed

source/contributor/ghostbsd-contributors-guide.md

Lines changed: 16 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -32,11 +32,13 @@ Follow the project’s branching strategy for development, feature, and release
3232
* **feature/xxx**: Feature branches for new developments.
3333
### 4.3. Cloning Repositories
3434
Clone the main repository:
35+
3536
```
3637
git clone [email protected]:ghostbsd/ghostbsd.git
3738
```
3839
### 4.4. Handling Merge Conflicts
3940
Resolve conflicts using Git:
41+
4042
```
4143
git fetch origin
4244
git checkout feature/branch
@@ -49,6 +51,7 @@ git commit
4951
## 5. Commit Messages
5052
### 5.1. Format
5153
Use the following format for commit messages:
54+
5255
```
5356
Subject Line (50 characters or less)
5457
@@ -89,9 +92,9 @@ Prioritize and categorize bug reports based on severity and impact.
8992
### 8.2. Resolution
9093
Work on resolving bugs in a timely manner, ensuring that fixes are well-tested.
9194
### 8.3. Examples
92-
High Priority: Critical system crashes.
93-
Medium Priority: Functionality issues.
94-
Low Priority: Minor UI bugs.
95+
* High Priority: Critical system crashes.
96+
* Medium Priority: Functionality issues.
97+
* Low Priority: Minor UI bugs.
9598

9699
## 9. Testing And Quality Assurance
97100
### 9.1. Automated Testing
@@ -101,31 +104,33 @@ Perform manual testing when necessary, especially for user-facing features.
101104
### 9.3. Continuous Integration
102105
Make use of the project’s continuous integration system to verify your changes.
103106
### 9.4. Guidelines for Writing Tests
104-
Use testing frameworks.
105-
Include unit tests for new features.
107+
* Use testing frameworks.
108+
* Include unit tests for new features.
106109

107110
## 10. Documentation
108111
### 10.1. Updating Documentation
109112
Ensure that all changes are reflected in the relevant documentation.
110113
### 10.2. Writing New Documentation
111114
Write clear, concise, and comprehensive documentation for new features and changes.
112115
### 10.3. Standards
113-
Use Markdown for documentation.
114-
Follow the project’s style guide.
116+
* Use Markdown for documentation.
117+
* Follow the project’s style guide.
115118
### 10.4. Tools
116-
MkDocs for documentation management.
119+
* MkDocs for documentation management.
117120

118121
## 11. Communication And Conduct
119122
### 11.1. Code of Conduct
120123
Adhere to the project’s code of conduct in all interactions.
121124
### 11.2. Communication Channels
122125
Use appropriate channels (mailing lists, forums, chat) for discussions and announcements.
123126
### 11.3. Examples of Proper Etiquette
124-
Respectful and constructive communication.
125-
Professionalism in all interactions.
127+
* Respectful and constructive communication.
128+
* Professionalism in all interactions.
126129

127130
## 12. Resources
128131
### 12.1. Documentation
129132
Access the project’s documentation portal for guidelines and references.
130133
### 12.2. Tools
131-
Recommended tools and utilities for development: * IDEs: VSCode, Sublime Text * Debugging Tools: GDB, LLDB
134+
Recommended tools and utilities for development:
135+
* IDEs: JetBrains IDEs, vscode, Sublime Text
136+
* Debugging Tools: GDB, LLDB

source/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
Welcome to GhostBSD's documentation portal!
22
===========================================
33

4-
This documentation portal has all of the information users need to get going with their journey using GhostBSD. It also contains information for people that want to help the community, report bugs, and contribute to the project.
4+
This documentation portal has all the information users need to get going with their journey using GhostBSD. It also contains information for people that want to help the community, report bugs, and contribute to the project.
55

66
## Overview
77

0 commit comments

Comments
 (0)