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

Commit bef7bc0

Browse files
committed
Create CONTRIBUTING.md
1 parent bf481d8 commit bef7bc0

File tree

1 file changed

+41
-0
lines changed

1 file changed

+41
-0
lines changed

CONTRIBUTING.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
BigNumbers Contributing Guidelines
2+
====================================
3+
4+
Contributing with Code
5+
----------------------
6+
7+
In first place, if you want to contribute code to php-bignumbers, you should have installed some PHP version,
8+
preferably recent versions (PHP>=5.3, but recommended PHP>=5.6), or *HHVM*.
9+
10+
If you don't know where to start, you can try searching inside the
11+
[issues list](https://github.com/Litipk/php-bignumbers/issues). Specially the ones marked with the
12+
[help wanted](https://github.com/Litipk/php-bignumbers/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
17+
important priority of this project.
18+
19+
20+
Contributing with Documentation
21+
-------------------------------
22+
23+
If you want to contribute documentation, you're welcome! :) , BUT, actually the documentation is pretty bad,
24+
and it's perfectly undersandable that this task isn't very attractive.
25+
26+
Contributing with Bug Reports
27+
-----------------------------
28+
29+
A very important part of every software project is the bugs tracking and solving process. You can send us bug reports through the [tracker](https://github.com/Litipk/php-bignumbers/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 are very helpful in order to achieve reproducibility:
32+
* Example code.
33+
* php-bignumbers version.
34+
* PHP version
35+
36+
Contributing with New Ideas
37+
---------------------------
38+
39+
You can use the github [tracker](https://github.com/Litipk/php-bignumbers/issues) to send us new ideas, even if those ideas aren't bug reports. In such case, adding something like "SUGGESTION: ...", "IMPROVEMENT: ..." to the report bug it's a good idea.
40+
41+
You can also discuss your ideas with us in our [Gitter chat room](https://gitter.im/Litipk/php-bignumbers).

0 commit comments

Comments
 (0)