Contribuind¶
Contribuțiile sunt binevenite și sunt foarte apreciate! Fiecare ajutor mic și creditul vor fi întotdeauna acordate”
Puteți contribui în multe feluri:
Tipuri de contribuții¶
Raportează bug-uri¶
Raportați bug-uri la adresa https://github.com/SekouD/mlconjug/issues”
Dacă raportați un bug, vă rugăm să includeți:
- Numele și versiunea sistemului de operare.
- Orice detalii despre configurația dvs. locală care ar putea fi de ajutor în rezolvarea problemelor.
- Pași detaliați pentru a reproduce bug-ul.
Fix Bugs¶
Uita-te prin problemele GitHub pentru bug-uri. Orice etichetat cu ” bug „si ” help wanted „este deschis oricui vrea sa o implementeze.
Caracteristicile implementării¶
Uitați-vă la problemele GitHub pentru caracteristici. Orice etichetat cu ” îmbunătățire „și ” help wanted „este deschis oricui dorește să îl implementeze.
Scrierea documentației¶
MLConjug ar putea folosi întotdeauna mai multă documentație, fie ca parte a documentelor oficiale MLConjug, în docstrings, sau chiar pe web în bloguri, articole și altele.
Trimite parerea ta¶
Cea mai bună modalitate de a trimite feedback este să trimiteți o problemă la adresa https://github.com/SekouD/mlconjug/issues.
Dacă propui o caracteristică:
- Explicați în detaliu modul în care ar funcționa.
- Țineți cât mai restrâns domeniul de aplicare, pentru a facilita implementarea acestuia”
- Amintiți-vă că acesta este un proiect bazat pe voluntari și că contribuțiile sunt binevenite :)
Incepe!¶
Ați venit să contribuiți? Iată cum puteți crea” mlconjug „pentru dezvoltarea locală.
Reportați repo-ul” mlconjug „pe GitHub.
Clonează-ți furca pe plan local
$ git clone git@github.com:your_name_here/mlconjug.git
Instalați-vă copia locală într-o virtualenv. Presupunând că aveți instalat virtualenvwrapper, acesta este modul în care vă configurați furculița pentru dezvoltarea locală:
$ mkvirtualenv mlconjug $ cd mlconjug/ $ python setup.py develop
Creați o sucursală pentru dezvoltarea locală:
$ git checkout -b name-of-your-bugfix-or-feature
Acum puteți face schimbările la nivel local.
Când ați terminat de făcut modificări, verificați dacă modificările dvs. trec prin flake8 și testele, inclusiv testarea altor versiuni Python cu tox
$ flake8 mlconjug tests $ python setup.py test or py.test $ tox
Pentru a obține flake8 și tox, pur și simplu instalați-le în virtualenv.
Comutați modificările și împingeți sucursala dvs. în GitHub
$ git add . $ git commit -m "Your detailed description of your changes." $ git push origin name-of-your-bugfix-or-feature
Trimiteți o solicitare de tragere prin intermediul site-ului GitHub.
Instrucțiuni de solicitare trageți¶
Înainte de a trimite o solicitare de tragere, verificați dacă respectă aceste linii directoare:
- Cererea de tragere ar trebui să includă teste.
- Dacă cererea de trasare adaugă funcționalitate, documentele trebuie să fie actualizate. Puneți noua funcție într-o funcție cu un docstring și adăugați caracteristica în lista în README.rst.
- The pull request should work for Python 3.3, 3.4, 3.5 and 3.6. Check https://travis-ci.org/SekouD/mlconjug/pull_requests and make sure that the tests pass for all supported Python versions.