Skip to content

Commit b3562c8

Browse files
Create CONTRIBUTING.md
1 parent d6e7aa5 commit b3562c8

File tree

1 file changed

+29
-0
lines changed

1 file changed

+29
-0
lines changed

CONTRIBUTING.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# Contributing
2+
We'd love for you to contribute to our source code and to make php Bolt library even better than it is today! Here are the guidelines we'd like you to follow.
3+
4+
## Code of Conduct
5+
Help us keep this project open and inclusive. Please read and follow our [Code of Conduct](https://github.com/neo4j-php/Bolt/blob/master/CODE_OF_CONDUCT.md).
6+
7+
## Did you find a bug?
8+
Ensure the bug was not already reported by searching on GitHub under [Issues](https://github.com/neo4j-php/Bolt/issues?q=is%3Aissue).
9+
10+
If you're unable to find an open issue addressing the problem, [open a new one](https://github.com/neo4j-php/Bolt/issues/new/choose). Be sure to include a title and clear description, as much relevant information as possible, and a code sample or an executable test case demonstrating the expected behavior that is not occurring.
11+
12+
## Did you write a piece of code?
13+
Open a new GitHub pull request with the patch. Don't forget to run phpunit when you make changes.
14+
15+
Ensure the PR description clearly describes the problem and solution. Include the relevant issue number if applicable.
16+
17+
## Clean code
18+
We like to keep the code unified and clean as possible.
19+
20+
- Follow PHP Standards Recommendations (PSR)
21+
- Avoid import with `use function <php_function>;`
22+
- Use type specification for method arguments
23+
- Set methods return type
24+
- Add descriptive method annotations if needed
25+
- Don't use @deprecated annotation
26+
- Follow Bolt specification by [official documentation](https://7687.org/)
27+
28+
\
29+
PHP Bolt library is a volunteer effort. We are thankful for your interest or contribution.

0 commit comments

Comments
 (0)