-
Notifications
You must be signed in to change notification settings - Fork 48
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
49 additions
and
29 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,29 +1,49 @@ | ||
# How to become a contributor and submit your own code | ||
|
||
- Fork the repository | ||
- Open your IDEA (or Android Studio) to change your settings: | ||
- Settings -> Editor -> Code Style -> Kotlin(Choose Project Schema) -> Imports -> | ||
- Top-Level Symbols: Use single name import | ||
- Java Statics and Enum Members: Use single name import | ||
- Packages to Use Import with "*": none | ||
- Create new branch from master or checkout **other** exist branches. | ||
- **Branch Naming Rules**: | ||
- > Release Package is allowed in MASTER branch only | ||
> and other contributors cannot change MASTER branch without PRs. | ||
- screen feature branch: feature_{module-name} | ||
- bug fix branch: fix_{keyword} | ||
- migrate platform branch: {target-platform}_migrate | ||
- other branch: build_{keyword} | ||
- **Commit Rules**: | ||
> format requirement: "lower-case", "space after the colon", "end of period" | ||
> {catalog}: {description}. | ||
- feat: new screen feature. | ||
- fix: bug fix. | ||
- docs: markdown files or comments update. | ||
- build: gradle files or project structure update. | ||
- upgrade(master only): release new version. | ||
- style: code style or naming update. | ||
- etc. | ||
- *CODING* in your branch | ||
- Make sure no warnings or errors existed then push your code. | ||
- Make sure completed staged code then you can make a pull request to MASTER branch. | ||
# How to Become a Contributor and Submit Your Own Code | ||
|
||
If you want to contribute to this repository, follow these steps: | ||
|
||
1. **Fork the Repository** | ||
|
||
2. **Configure Your IDE (IDEA or Android Studio)** | ||
- Navigate to `Settings` -> `Editor` -> `Code Style` -> `Kotlin` (Choose Project Schema) -> `Imports`. | ||
- Set the following options: | ||
- Top-Level Symbols: Use single name import. | ||
- Java Statics and Enum Members: Use single name import. | ||
- Packages to Use Import with "*": none. | ||
|
||
3. **Create a New Branch** | ||
- Create a new branch from the `master` branch or checkout existing branches. | ||
|
||
**Branch Naming Rules**: | ||
- Release Package is allowed in the `MASTER` branch only, and other contributors cannot change `MASTER` branch without PRs. | ||
- Use the following naming conventions: | ||
- Screen feature branch: `feature_{module-name}` | ||
- Bug fix branch: `fix_{keyword}` | ||
- Migrate platform branch: `{target-platform}_migrate` | ||
- Other branch: `build_{keyword}` | ||
|
||
4. **Commit Rules** | ||
- Follow this format for your commits: "lower-case", "space after the colon", "end with a period". | ||
- Use this format: `{catalog}: {description}`. | ||
- Examples: | ||
- `feat: new screen feature` | ||
- `fix: bug fix` | ||
- `docs: markdown files or comments update` | ||
- `build: gradle files or project structure update` | ||
- `upgrade (master only): release new version` | ||
- `style: code style or naming update` | ||
- `etc` | ||
|
||
5. **Coding in Your Branch** | ||
- Start coding in your branch and make the necessary changes. | ||
|
||
6. **Check for Warnings and Errors** | ||
- Ensure that there are no warnings or errors in your code. | ||
|
||
7. **Push Your Code** | ||
- Once your code is ready, push it to your branch. | ||
|
||
8. **Make a Pull Request** | ||
- If your staged code is complete and error-free, you can create a pull request to the `MASTER` branch. | ||
|
||
Following these guidelines will help streamline the contribution process. Thank you for your contribution! |