Skip to content

Commit fcf5132

Browse files
committed
returned back
1 parent 8a35f44 commit fcf5132

File tree

1 file changed

+32
-0
lines changed

1 file changed

+32
-0
lines changed

CONTRIBUTING.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
## 🤝 Contributing to OMath or other Orange's Projects
2+
3+
### ❕ Prerequisites
4+
5+
- A working up-to-date OMath installation
6+
- C++ knowledge
7+
- Git knowledge
8+
- Ability to ask for help (Feel free to create empty pull-request or PM a maintainer
9+
in [Telegram](https://t.me/orange_cpp))
10+
11+
### ⏬ Setting up OMath
12+
13+
Please read INSTALL.md file in repository
14+
15+
### 🔀 Pull requests and Branches
16+
17+
In order to send code back to the official OMath repository, you must first create a copy of OMath on your github
18+
account ([fork](https://help.github.com/articles/creating-a-pull-request-from-a-fork/)) and
19+
then [create a pull request](https://help.github.com/articles/creating-a-pull-request-from-a-fork/) back to OMath.
20+
21+
OMath developement is performed on multiple branches. Changes are then pull requested into master. By default, changes
22+
merged into master will not roll out to stable build users unless the `stable` tag is updated.
23+
24+
### 📜 Code-Style
25+
26+
The orange code-style can be found in `.clang-format`.
27+
28+
### 📦 Building
29+
30+
OMath has already created the `cmake-build` and `out` directories where cmake/bin files are located. By default, you
31+
can build cathook by running `cmake --build cmake-build/build/windows-release --target omath -j 6` in the source
32+
directory.

0 commit comments

Comments
 (0)