Please follow the instructions below for contributing to lign. Contributions that do not follow the guidelines below may be removed or closed at the discretion of the reviewer.
These are instructions for getting started with development. If only interested in the package, please install Lign via pip install lign, conda install lign -c josuecom -c pytorch or by downloading the package from github and saving it in the site-packages/ directory of your python interpreter.
For more details, please read the developer documentation
-
Clone the repo
git clone https://github.com/JosueCom/Lign.git
-
Switch directory
cd Lign -
Install prerequisites
It is recommended to install PyTorch via the official site first for optimal performance
pip install -r docs/dev/requirements.txt
conda env create -f docs/dev/environment.yml -n lign conda activate lign
-
Install package
pip install . --upgrade
When contributing to the Lign, please make sure to follow these instruction and document any changes made.
-
Fork the project
-
Create your feature branch
git checkout -b feature/amazing-feature
-
Commit your changes + documentation
git commit -m 'Add some AmazingFeature' -
Push to the branch
git push origin feature/AmazingFeature
-
Open a Pull Request
If you contribute to lign, you must follow the following standards and document any changes made as described below. There are four types of documentations that may be made based on the extend of the contribution.
When contributing any changes, first document your code by following the convention under Docstring. After, create a pull request. Lastly, insert and fill the following template in the pull request description.
Create one pull request for each independent overall functionality. Do not include multiple unrelated functionalities into one request.
When reporting an issue, use the discussion panel on GitHub to discuss it with the community first. If (1) no response is given after 24 hours or an inarticulate respond was given, (2) the issue is considered novel and (3) no duplicate issue(s) exist, feel free to submit a request by creating an issue with the following template. Additionally, insert [ISSUE] or [BUG] in the title of the GitHub Issue. Contributions that do not follow these guidelines may be removed or closed at the discretion of the reviewer.
Create one issue for each independent problem. Do not group multiple unrelated issues into one report.
When requesting a feature, use the discussion panel on GitHub to discuss it with the community first. If (1) no response is given after 24 hours or an unsatisfactory respond is given, (2) the feature is considered benefitial and (3) no duplicate feature(s) exist, feel free to submit a request by creating an issue with the following template. Additionally, insert [FEATURE] or [IMPROVEMENT] in the title of the GitHub Issue. Contributions that do not follow these guidelines may be removed or closed at the discretion of the reviewer
Create one feature for each independent improvement. Do not group multiple unrelated features into one report
Any changes made to the source code (ling/) must be documented using Google style python docstrings. Refer to napoleon readthedocs for an example of Google style python docstrings.
Feel free to read the developer documentation for more information about contributing to Lign.