Skip to content

Latest commit

 

History

History
31 lines (22 loc) · 1.54 KB

contributing.md

File metadata and controls

31 lines (22 loc) · 1.54 KB

Contributing to PROGRAMMING.IN.TH's solutions

Steps

  1. Fork this repository to your own GitHub account and then clone it to your local device.
  2. Create a new branch git checkout -b MY_BRANCH_NAME (MY_BRANCH_NAME should be the same with patch you are working on Ex. add_0001 / fix_0001)
  3. Open pull request.

Guidelines

  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.
  1. All mathematical notation must be in latex math format.
  2. All in-line codes must in backticks.
  3. 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

Markdown Preview

  • Markdown files will be rendered by a function that can be previewed at programming.in.th/render, please preview your markdown file before submitting pull request.