Skip to content

Commit da5c250

Browse files
committed
docs(contrib): added contribution guidelines
1 parent cfb71ec commit da5c250

File tree

1 file changed

+35
-1
lines changed

1 file changed

+35
-1
lines changed

CONTRIBUTION.md

+35-1
Original file line numberDiff line numberDiff line change
@@ -1 +1,35 @@
1-
# Instructions for contributors
1+
# Instruction for contributors
2+
3+
> **Note**: _The project strictly uses `poetry` package manager so do not push
4+
> any `requirements.txt` file or other package management files._
5+
6+
Rules to contribute to projects:
7+
8+
- The main goal of this project is to unify payment process so we must inherit
9+
abstract classes for creating a new payment method.
10+
11+
- Do not use highly offensive or racist words anywhere including variable names,
12+
examples, and requirement specification.
13+
14+
- The solution should be capable of running on all operating systems.
15+
If not, mention in the respective section in documentation
16+
17+
18+
## Placeholders
19+
Placeholders are not strict and we may use any name for them, but please try to
20+
name them so that everyone who understands English can understand them properly.
21+
22+
We may use name of fictional characters of Sci-fi movies too
23+
but we should make sure that those names should not impact sentiments of people
24+
of any region, race, or gender.
25+
26+
Examples of some placeholders:
27+
28+
1. **Person**: `John Doe` `Darth Vader`, `Sheldon`, `Iron Man`, `Yoda`, etc.
29+
2. **Place**: `High Street`, `Wakanda`, `Vulkan`, `Tatooine`, etc.
30+
3. **Organization**: `Ace`, `Galactic Republic`, `Jedi`, `Enterprise`, ``, etc.
31+
4. **Domain Names** `example.com`, `starwars.com`, `johndoe.com`, etc.
32+
33+
34+
> **Note**: All of the above guidelines are created just for the reference and
35+
> may not be used as a proof for any legal actions.

0 commit comments

Comments
 (0)