Skip to content
Merged

Dev #97

Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion .prettierignore
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,6 @@ dist
node_modules
src-tauri/target
src-tauri/gen
pnpm-lock.yaml
pnpm-lock.yaml

.github/*
105 changes: 53 additions & 52 deletions Contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,18 @@

Thank you for your interest in contributing to CommDesk.

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

## Before You Start

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

This repository includes:
- A *React* + *TypeScript* **frontend**
- A *Tauri* **desktop application** layer
- A *Rust* backend under `src-tauri`
- *Documentation* for project scope, implementation status, and release flow

- A _React_ + _TypeScript_ **frontend**
- A _Tauri_ **desktop application** layer
- A _Rust_ backend under `src-tauri`
- _Documentation_ for project scope, implementation status, and release flow

## Prerequisites

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

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

## Getting Started

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

### Run the Application

Expand All @@ -58,33 +59,33 @@ pnpm dev

## Branch Naming

Use a *descriptive branch name* for your work.
Use a _descriptive branch name_ for your work.

Recommended formats:

* `feature/<short-description>`
* `fix/<short-description>`
* `docs/<short-description>`
* `refactor/<short-description>`
- `feature/<short-description>`
- `fix/<short-description>`
- `docs/<short-description>`
- `refactor/<short-description>`

Examples:

* `feature/member-search`
* `fix/login-error`
* `docs/update-readme`
- `feature/member-search`
- `fix/login-error`
- `docs/update-readme`

## Coding Standards

Please follow the existing *code style* and *project conventions*.
Please follow the existing _code style_ and _project conventions_.

General expectations:

* Keep changes focused and minimal
* Write clear, readable, and maintainable code
* Follow the current folder structure and architecture
* Avoid introducing unnecessary dependencies
* Prefer small, reusable components and functions
* Keep frontend and backend changes consistent with the existing design
- Keep changes focused and minimal
- Write clear, readable, and maintainable code
- Follow the current folder structure and architecture
- Avoid introducing unnecessary dependencies
- Prefer small, reusable components and functions
- Keep frontend and backend changes consistent with the existing design

Before submitting, format and lint your code where applicable.

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

At minimum, verify:

* The application starts successfully
* The change works as intended
* Existing functionality is not broken
* The project passes linting and build checks where relevant
- The application starts successfully
- The change works as intended
- Existing functionality is not broken
- The project passes linting and build checks where relevant

Useful commands:

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

Before opening a new issue:

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

A good bug report should explain:

* What you expected to happen
* What actually happened
* How to reproduce the issue
* Which platform and version you used
- What you expected to happen
- What actually happened
- How to reproduce the issue
- Which platform and version you used

## Pull Request Guidelines

When opening a pull request, please ensure that:

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

A strong pull request should include:

* A short summary of the change
* Screenshots or recordings for UI updates
* Testing notes
* Any relevant context for reviewers
- A short summary of the change
- Screenshots or recordings for UI updates
- Testing notes
- Any relevant context for reviewers

## Commit Messages

Use concise and meaningful commit messages.

Recommended style:

* `feat: add member search`
* `fix: resolve updater issue`
* `docs: improve contribution guide`
* `refactor: simplify event module`
- `feat: add member search`
- `fix: resolve updater issue`
- `docs: improve contribution guide`
- `refactor: simplify event module`

## Security and Secrets

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

Be considerate in:

* Issues
* Pull requests
* Code reviews
* Documentation discussions
- Issues
- Pull requests
- Code reviews
- Documentation discussions

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

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

## License

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