Skip to content

Commit 7c42130

Browse files
Merge pull request #97 from NexGenStudioDev/dev
Dev
2 parents 8def030 + 5736a31 commit 7c42130

91 files changed

Lines changed: 4639 additions & 1737 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.prettierignore

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,6 @@ dist
22
node_modules
33
src-tauri/target
44
src-tauri/gen
5-
pnpm-lock.yaml
5+
pnpm-lock.yaml
6+
7+
.github/*

Contributing.md

Lines changed: 53 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -2,17 +2,18 @@
22

33
Thank you for your interest in contributing to CommDesk.
44

5-
***CommDesk*** is a desktop platform for *communities*, *clubs*, *organizations*, and *event teams*. Contributions that improve *usability*, *reliability*, *documentation*, *maintainability*, and *developer experience* are welcome.
5+
**_CommDesk_** is a desktop platform for _communities_, _clubs_, _organizations_, and _event teams_. Contributions that improve _usability_, _reliability_, _documentation_, _maintainability_, and _developer experience_ are welcome.
66

77
## Before You Start
88

99
Before making changes, please review the **existing documentation** and **project structure** to understand the current scope of the repository.
1010

1111
This repository includes:
12-
- A *React* + *TypeScript* **frontend**
13-
- A *Tauri* **desktop application** layer
14-
- A *Rust* backend under `src-tauri`
15-
- *Documentation* for project scope, implementation status, and release flow
12+
13+
- A _React_ + _TypeScript_ **frontend**
14+
- A _Tauri_ **desktop application** layer
15+
- A _Rust_ backend under `src-tauri`
16+
- _Documentation_ for project scope, implementation status, and release flow
1617

1718
## Prerequisites
1819

@@ -23,7 +24,7 @@ To work on this project, you should have the following installed:
2324
- **Rust stable** (`rustup`, `cargo`)
2425
- The platform-specific dependencies required by **Tauri**
2526

26-
For *Linux*, *macOS*, and *Windows*, please ensure the appropriate system dependencies are installed before building the project.
27+
For _Linux_, _macOS_, and _Windows_, please ensure the appropriate system dependencies are installed before building the project.
2728

2829
## Getting Started
2930

@@ -40,7 +41,7 @@ For *Linux*, *macOS*, and *Windows*, please ensure the appropriate system depend
4041
git clone https://github.com/NexGenStudioDev/CommDesk.git
4142
cd CommDesk
4243
pnpm install
43-
````
44+
```
4445

4546
### Run the Application
4647

@@ -58,33 +59,33 @@ pnpm dev
5859

5960
## Branch Naming
6061

61-
Use a *descriptive branch name* for your work.
62+
Use a _descriptive branch name_ for your work.
6263

6364
Recommended formats:
6465

65-
* `feature/<short-description>`
66-
* `fix/<short-description>`
67-
* `docs/<short-description>`
68-
* `refactor/<short-description>`
66+
- `feature/<short-description>`
67+
- `fix/<short-description>`
68+
- `docs/<short-description>`
69+
- `refactor/<short-description>`
6970

7071
Examples:
7172

72-
* `feature/member-search`
73-
* `fix/login-error`
74-
* `docs/update-readme`
73+
- `feature/member-search`
74+
- `fix/login-error`
75+
- `docs/update-readme`
7576

7677
## Coding Standards
7778

78-
Please follow the existing *code style* and *project conventions*.
79+
Please follow the existing _code style_ and _project conventions_.
7980

8081
General expectations:
8182

82-
* Keep changes focused and minimal
83-
* Write clear, readable, and maintainable code
84-
* Follow the current folder structure and architecture
85-
* Avoid introducing unnecessary dependencies
86-
* Prefer small, reusable components and functions
87-
* Keep frontend and backend changes consistent with the existing design
83+
- Keep changes focused and minimal
84+
- Write clear, readable, and maintainable code
85+
- Follow the current folder structure and architecture
86+
- Avoid introducing unnecessary dependencies
87+
- Prefer small, reusable components and functions
88+
- Keep frontend and backend changes consistent with the existing design
8889

8990
Before submitting, format and lint your code where applicable.
9091

@@ -94,10 +95,10 @@ All contributions should be tested locally before submission.
9495

9596
At minimum, verify:
9697

97-
* The application starts successfully
98-
* The change works as intended
99-
* Existing functionality is not broken
100-
* The project passes linting and build checks where relevant
98+
- The application starts successfully
99+
- The change works as intended
100+
- Existing functionality is not broken
101+
- The project passes linting and build checks where relevant
101102

102103
Useful commands:
103104

@@ -113,45 +114,45 @@ If your contribution affects desktop packaging or Rust functionality, test the r
113114

114115
Before opening a new issue:
115116

116-
* Search existing issues to avoid duplicates
117-
* Use a clear and descriptive title
118-
* Include steps to reproduce the problem
119-
* Add screenshots, logs, or environment details when relevant
117+
- Search existing issues to avoid duplicates
118+
- Use a clear and descriptive title
119+
- Include steps to reproduce the problem
120+
- Add screenshots, logs, or environment details when relevant
120121

121122
A good bug report should explain:
122123

123-
* What you expected to happen
124-
* What actually happened
125-
* How to reproduce the issue
126-
* Which platform and version you used
124+
- What you expected to happen
125+
- What actually happened
126+
- How to reproduce the issue
127+
- Which platform and version you used
127128

128129
## Pull Request Guidelines
129130

130131
When opening a pull request, please ensure that:
131132

132-
* The pull request has a clear title
133-
* The description explains what was changed and why
134-
* Related issues are linked when applicable
135-
* The changes are limited to a single purpose where possible
136-
* The branch is up to date with the target branch before submission
133+
- The pull request has a clear title
134+
- The description explains what was changed and why
135+
- Related issues are linked when applicable
136+
- The changes are limited to a single purpose where possible
137+
- The branch is up to date with the target branch before submission
137138

138139
A strong pull request should include:
139140

140-
* A short summary of the change
141-
* Screenshots or recordings for UI updates
142-
* Testing notes
143-
* Any relevant context for reviewers
141+
- A short summary of the change
142+
- Screenshots or recordings for UI updates
143+
- Testing notes
144+
- Any relevant context for reviewers
144145

145146
## Commit Messages
146147

147148
Use concise and meaningful commit messages.
148149

149150
Recommended style:
150151

151-
* `feat: add member search`
152-
* `fix: resolve updater issue`
153-
* `docs: improve contribution guide`
154-
* `refactor: simplify event module`
152+
- `feat: add member search`
153+
- `fix: resolve updater issue`
154+
- `docs: improve contribution guide`
155+
- `refactor: simplify event module`
155156

156157
## Security and Secrets
157158

@@ -165,10 +166,10 @@ Please keep discussions respectful, constructive, and professional.
165166

166167
Be considerate in:
167168

168-
* Issues
169-
* Pull requests
170-
* Code reviews
171-
* Documentation discussions
169+
- Issues
170+
- Pull requests
171+
- Code reviews
172+
- Documentation discussions
172173

173174
This project follows a [code of conduct](CODE_OF_CONDUCT.md). All contributors are expected to follow it.
174175

@@ -178,4 +179,4 @@ Maintainers may request changes before merging a pull request. Please respond to
178179

179180
## License
180181

181-
**By contributing to CommDesk, you agree that your contributions will be made under the same [License](LICENSE) as the project.**
182+
**By contributing to CommDesk, you agree that your contributions will be made under the same [License](LICENSE) as the project.**

0 commit comments

Comments
 (0)