Skip to content

Commit 2978203

Browse files
authored
Merge pull request #75 from cybozu/add-contributing-md
Added CONTRIBUTING.md
2 parents 9f4b365 + 6cf80bd commit 2978203

File tree

2 files changed

+35
-0
lines changed

2 files changed

+35
-0
lines changed

CONTRIBUTING.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# Contributing Guide
2+
3+
This document is a guideline for contributing to WebUI.
4+
5+
We Welcome Your Contribution!
6+
We value and appreciate your contributions. This project thrives due to the support and collaboration of our community members.
7+
8+
## Language Policy
9+
10+
When creating Issues or Pull Requests, please write in **English**. This ensures effective communication among contributors from diverse backgrounds.
11+
12+
## Start Contributing
13+
14+
1. **Create an Issue**
15+
If you find a problem or have a suggestion for a new feature, start by creating an issue. This provides a platform to discuss with other contributors and maintainers. If you spot a typo or other small mistake, feel free to create a pull request directly.
16+
17+
2. **Fork and Clone**
18+
Before proposing your changes, fork this repository and clone it locally.
19+
20+
3. **Create a Branch**
21+
When suggesting a new feature or fix, create a branch with a appropriate branch name. There is no fixed format for branch names.
22+
23+
4. **Commit and Push Your Changes**
24+
Commit your changes to your local branch and push them to your forked repository.
25+
26+
5. **Create a Pull Request**
27+
To get your changes merged into this repository, create a pull request with a appropriate title. There is no fixed format for pull request titles.
28+
29+
## Code Style Guide
30+
31+
Follow [Swift API Design Guidelines](https://www.swift.org/documentation/api-design-guidelines/).

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -160,6 +160,10 @@ WebUI is available through [Swift Package Manager](https://github.com/apple/swif
160160

161161
This library does not collect or track user information, so it does not include a PrivacyInfo.xcprivacy file.
162162

163+
## Contributing to WebUI
164+
165+
Contributions to WebUI are welcomed and encouraged! Please see the [Contributing Guide](/CONTRIBUTING.md).
166+
163167
## Demo
164168

165169
This repository includes demonstration app for iOS & macOS.

0 commit comments

Comments
 (0)