Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add contributing info #10

Merged
merged 1 commit into from
Nov 21, 2024
Merged
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
72 changes: 72 additions & 0 deletions CONTRIBUTE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
# Contributing Guidelines

Thank you for contributing to our project! Please adhere to the following guidelines to maintain code quality and consistency across the repository.

---

## Commit and Branch Requirements

### Branches
- **`main` branch**:
- Contains production-ready code. No direct commits are allowed here.
- **`feature/*` sub-branches**:
- Used for developing new features.
- Must include the issue ID and a brief title.
- Example: `feature/100200_add-new-feature`.
- **`bugfix/*` sub-branches**:
- Used for fixing bugs.
- Must include the issue ID and a brief title.
- Example: `bugfix/20101_fix-something`.

---

### Commits
- **Multiline commits are accepted.**
- The **first line** of the commit must:
- Contain the issue ID.
- Specify the type: `[FEATURE]` or `[BUG]`.
- Include a short, descriptive title.
- Be followed by a line break.
- Subsequent lines should:
- Use bullet points (`-`) to briefly describe the changes.

#### **Commit Example:**
```
480100: [FEATURE] Add new feature API

- do this
- do that
```

---

## Pull Requests
- **Required Reviewer**:
- All pull requests must include `@ownerofglory` as a required reviewer.
- **Optional Reviewers**:
- One or more optional reviewers can be added as needed.
- **Pipeline**:
- All pull requests must pass the pipeline successfully.

---

## Definition of 'Done' (DoD)

### **Code Quality and Functionality**
- Code changes must:
- Be thoroughly reviewed and free of new bugs.
- Compile and build without errors.
- Align with the project's design and architecture.

### **Testing**
- Code changes must:
- Be covered by unit tests.
- Pass all unit tests (green status).

### **Documentation**
- Relevant documentation must:
- Be updated to reflect any changes in the codebase.

---

By following these guidelines, you help us maintain a high-quality codebase and streamline the development process. Thank you for your cooperation and contributions!
Loading