Skip to content

Commit

Permalink
Update CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
hydraxman authored Feb 28, 2023
1 parent 7c80045 commit 501b76d
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,15 @@ And you can also trigger the run in the Gradle panel of IDEA:

![image](https://user-images.githubusercontent.com/8344245/220255351-8bd2db47-9e4b-407c-9444-ac982173f77b.png)

### Design a new feature/solution/architecture upgrade

*Drafting.* If you are going to apply a huge change to the code, to minimize the possible impact and code review pressure, here are some guide on the general steps we can follow:
- Create a new PR for UML update to clarify/illustrate the changes on class relations and new interface definitions.
- Create a PR to check in the interfaces and abstract classes, and create some unit test to define the behavior of the entities/components.
- Start the PR(s) for implementation and tweak the UT during the process.

Ideally, the above steps could help you win incremental approval from the team and

## Coding style conventions

Under most cases, new file/folder name should follow the [snake case](https://en.wikipedia.org/wiki/Snake_case) style patterns. A fully capitalized name should come with a reasonable justification.
Expand Down

0 comments on commit 501b76d

Please sign in to comment.