Skip to content
This repository was archived by the owner on Dec 27, 2023. It is now read-only.

Commit 626c94c

Browse files
committed
Create CONTRIBUTING.md
1 parent c812cae commit 626c94c

File tree

1 file changed

+45
-0
lines changed

1 file changed

+45
-0
lines changed

CONTRIBUTING.md

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
Jupyter-PHP Contributing Guidelines
2+
====================================
3+
4+
Contributing with Code
5+
----------------------
6+
7+
In first place, if you want to contribute code to Jupyter-PHP, you must have installed PHP, preferably recent
8+
versions (PHP>=5.5, but recommended PHP>=7.0).
9+
10+
If you don't know where to start, you can try searching inside the
11+
[issues list](https://github.com/Litipk/Jupyter-PHP/issues). Specially the ones marked with the
12+
[help wanted](https://github.com/Litipk/Jupyter-PHP/labels/help%20wanted) tag.
13+
14+
Some extra advices related on good practices:
15+
* We try to follow the PSR standards, in special **PSR-1**, **PSR-2** and **PSR-4**.
16+
* Every new added feature should come with unit tests, stability and code correctness is an important priority of this project.
17+
18+
19+
Contributing with Documentation
20+
-------------------------------
21+
22+
If you want to contribute documentation, you're welcome! :) , BUT, actually the documentation is pretty bad, and it's perfectly
23+
undersandable that this task isn't very attractive.
24+
25+
Contributing with Bug Reports
26+
-----------------------------
27+
28+
A very important part of every software project is the bugs tracking and solving process. You can send us bug reports through
29+
the [tracker](https://github.com/Litipk/Jupyter-PHP/issues).
30+
31+
It's desirable that every bug report explains the bug in a way that the developers can easily reproduce it. The following points
32+
are very helpful in order to achieve reproducibility:
33+
* Example code.
34+
* Jupyter version
35+
* Jupyter-PHP version.
36+
* Python version
37+
* PHP version
38+
39+
Contributing with New Ideas
40+
---------------------------
41+
42+
You can use the github [tracker](https://github.com/Litipk/Jupyter-PHP/issues) to send us new ideas, even if those ideas aren't
43+
bug reports. In such case, adding something like "SUGGESTION: ...", "IMPROVEMENT: ..." to the report bug it's a good idea.
44+
45+
You can also discuss your ideas with us in our [Gitter chat room](https://gitter.im/Litipk/Jupyter-PHP).

0 commit comments

Comments
 (0)