-
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Abdelaziz Sharaf
committed
Dec 28, 2019
0 parents
commit 606e112
Showing
72 changed files
with
5,933 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
.*/ | ||
*.pyc | ||
*~ | ||
*.db | ||
*.sqlite3 | ||
i_catalog/secrets/FB_app_secrets.json | ||
__pycache__/ | ||
i_catalog/__pycache__/ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,80 @@ | ||
# How to contribute | ||
|
||
I'm really glad you're reading this, because the community needs your efforts. | ||
|
||
if this is your first contribute on github, | ||
those are some helpfull rasorces to do that perfectly: | ||
1. [Setting guidelines for repository contributors][x1] | ||
2. [How to contribute to a project on Github][x2] | ||
|
||
## Testing | ||
|
||
We don't have a specific teaching technique to go throw, | ||
but please read how we started [testing][1] to meet our minimum small tests | ||
|
||
## Submitting changes | ||
|
||
Please send a [GitHub Pull Request to iCatalog][2] with a clear list of what | ||
you've done (read more about [pull requests][3]). | ||
|
||
Please follow our coding conventions (+along with PEP8) and make sure all of | ||
your commits are atomic (one feature per commit). | ||
|
||
Always write a clear log message for your commits. One-line messages are fine for small changes, but bigger changes should look like this: | ||
|
||
```bash | ||
$ git commit -m "A brief summary of the commit | ||
> | ||
> A paragraph describing what changed and its impact." | ||
``` | ||
|
||
## Coding conventions | ||
|
||
Start reading our code and you'll get the hang of it. We optimize for readability: | ||
|
||
- starting from [PEP8][4] | ||
- importing more than 3 subclasses from a module (or subclass) | ||
should be separated in multilines like this | ||
```python | ||
from flask import ( | ||
Flask, | ||
jsonify, | ||
Blueprint, | ||
render_template | ||
) | ||
``` | ||
same thing with long names | ||
- imports are orderd in stair like order the less name length followed | ||
by longer till longest, like this | ||
```python | ||
from . import db, login_manager | ||
from .fn import rand_str | ||
from .crud import cuCRUD, rCRUD, gen_pid, gen_tk | ||
from .models import Usr | ||
``` | ||
also multiline subclasses | ||
- only import subclass you need and do not import the itire module as all | ||
- use functional or Object Oreinted Programing as you could instaid off | ||
proceedual programming | ||
- | ||
- avoid comments inside templates | ||
- comment everything you do with a jonuor/student readable comments | ||
|
||
# finally | ||
- have a look on previous code | ||
|
||
``` | ||
of course I can't be a successful if no one succeded, | ||
it's for education [the project and it's code | ||
``` | ||
|
||
**Thanks for even being here** | ||
|
||
|
||
[x1]: https://help.github.com/en/github/building-a-strong-community/setting-guidelines-for-repository-contributors | ||
[x2]: https://gist.github.com/7303312.git | ||
|
||
[1]: https://github.com/AbdelazizSharaf001/iCatalog/tree/master/docs/Dev.md#testing | ||
[2]: https://github.com/AbdelazizSharaf001/iCatalog/pull/new/master | ||
[3]: http://help.github.com/pull-requests/ | ||
[4]: https://www.python.org/dev/peps/pep-0008 |
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,27 @@ | ||
[[source]] | ||
url = "https://pypi.python.org/simple" | ||
verify_ssl = true | ||
name = "pypi" | ||
|
||
[packages] | ||
certifi = ">=2018.8.24" | ||
click = ">=7.0" | ||
Flask = ">=1.1.1" | ||
Flask-Login = ">=0.4.1" | ||
Flask-Mail = ">=0.9.1" | ||
Flask-SQLAlchemy = ">=2.4.1" | ||
google-api-python-client = ">=1.7.11" | ||
gunicorn = ">=20.0.4" | ||
httplib2 = ">=0.11.3" | ||
nltk = "*" | ||
oauth2client = ">=4.1.3" | ||
oauthlib = ">=2.1.0" | ||
pipenv = ">=11.9.0" | ||
psycopg2 = ">=2.8.4" | ||
pycodestyle = ">=2.5.0" | ||
requests = ">=2.21.0" | ||
|
||
[dev-packages] | ||
|
||
[requires] | ||
python_version = "3.7" |
Oops, something went wrong.