Merge pull request #28 from Pogchamp-company/feature/-/create-communi…

…ty-docs

Create community docs

.github/pull_request_template.md

@@ -0,0 +1,27 @@
+<!-- Provide a general summary of your proposed changes in the Title field above -->
+
+### Description
+<!-- Describe your changes in detail -->
+
+### Checklist
+<!-- go over following points. check them with an `x` if they do apply, (they turn into clickable checkboxes once the PR is submitted, so no need to do everything at once)
+
+-->
+
+This pull request is:
+
+- [ ] A documentation / typographical / small typing error fix
+	- Good to go, no issue or tests are needed
+- [ ] A short code fix
+	- please include the issue number, and create an issue if none exists, which
+	  must include a complete example of the issue.  one line code fixes without an
+	  issue and demonstration will not be accepted.
+	- Please include: `Fixes: #<issue number>` in the commit message
+	- please include tests.   one line code fixes without tests will not be accepted.
+- [ ] A new feature implementation
+	- please include the issue number, and create an issue if none exists, which must
+	  include a complete example of how the feature would look.
+	- Please include: `Fixes: #<issue number>` in the commit message
+	- please include tests.
+
+**Have a nice day!**

README.md

@@ -38,7 +38,7 @@ To the top of your migrations/env.py file.
 * [Deletion of enums values](#deletion-of-enums-values)
 * [Renaming of enum values](#rename-enum-value)
 
-### Creation of enum
+### Creation of enum<a id="creation-of-enum"></a>
 
 #### When table is created
 
@@ -109,7 +109,7 @@ def downgrade():
     # ### end Alembic commands ###
 ```
 
-### Deletion of unreferenced enum
+### Deletion of unreferenced enum<a id="deletion-of-unreferenced-enum"></a>
 If enum is defined in postgres schema, but its mentions removed from code - It will be automatically removed
 ```python
 class ExampleTable(BaseModel):
@@ -132,7 +132,7 @@ def downgrade():
     # ### end Alembic commands ###
 ```
 
-### Creation of new enum values
+### Creation of new enum values<a id="creation-of-new-enum-values"></a>
 
 If new enum value is defined sync_enum_values function call will be added to migration to account for it
 
@@ -161,7 +161,7 @@ def downgrade():
     # ### end Alembic commands ###
 ```
 
-### Deletion of enums values
+### Deletion of enums values<a id="deletion-of-enums-values"></a>
 
 If enum value is removed it also will be detected
 
@@ -189,7 +189,7 @@ def downgrade():
     # ### end Alembic commands ###
 ```
 
-### Rename enum value
+### Rename enum value<a id="rename-enum-value"></a>
 In this case you must manually edit migration
 
 ```python