Skip to content

Commit

Permalink
add recommendation to contributing.md (#131)
Browse files Browse the repository at this point in the history
* add recommendation to contributing.md

* Update contributing.md

Co-authored-by: Nutthapat Pongtanyavichai <[email protected]>

---------

Co-authored-by: Nutthapat Pongtanyavichai <[email protected]>
  • Loading branch information
MasterIceZ and leomotors authored Jul 24, 2023
1 parent e6d555f commit 1cc2fbe
Showing 1 changed file with 16 additions and 9 deletions.
25 changes: 16 additions & 9 deletions contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,15 +10,22 @@

1. Providing code without explaination is **strictly prohibited**
2. General guideline for organizing solution is the following:
- Clearly states the problem(s) at hands
- Provide general solution for each of the problem
- Explains any specific algorithm(s) associated with this problem. (General concepts, such as sorting, Dijkstra's, dynamic programming, can be omitted, but we encouraged to put backlinks in appendix)
- If the previous 2 steps are not enough for explaining, you can provide example code with comments or walkthrough.

- Clearly states the problem(s) at hands
- Provide general solution for each of the problem
- Explains any specific algorithm(s) associated with this problem. (General concepts, such as sorting, Dijkstra's, dynamic programming, can be omitted, but we encouraged to put backlinks in appendix)
- If the previous 2 steps are not enough for explaining, you can provide example code with comments or walkthrough.

3. All mathematical notation must be in latex math format.
4. All in-line codes must in backticks.
5. Code blocks must be formatted in their respective style. The following is just recommendation, but any style that diverts from the recommendation should be indicated in pull request.
- C++: LLVM or Google style
- Rust: rustfmt style
- Java: TBD
- Python: TBD
- Go: gofmt

- C++: LLVM or Google style
- Rust: rustfmt style
- Java: TBD
- Python: TBD
- Go: gofmt

## Recommendation

- Markdown files will be rendered by a function that can be previewed at [programming.in.th/render](https://programming.in.th/render)

0 comments on commit 1cc2fbe

Please sign in to comment.