Skip to content

Commit

Permalink
[IMP] Improve readme and gitignore files
Browse files Browse the repository at this point in the history
  • Loading branch information
svazquezco committed Dec 12, 2018
1 parent a86e80b commit 66a7178
Show file tree
Hide file tree
Showing 2 changed files with 55 additions and 101 deletions.
106 changes: 5 additions & 101 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,104 +1,8 @@
# Byte-compiled / optimized / DLL files
__pycache__/
*.py[cod]
*$py.class
*.swp
*~
# Remove IDE files
.idea/

# C extensions
*.so
.vscode/

# Distribution / packaging
.Python
build/
develop-eggs/
dist/
downloads/
eggs/
.eggs/
lib/
lib64/
parts/
sdist/
var/
wheels/
*.egg-info/
.installed.cfg
*.egg
MANIFEST

# PyInstaller
# Usually these files are written by a python script from a template
# before PyInstaller builds the exe, so as to inject date/other infos into it.
*.manifest
*.spec

# Installer logs
pip-log.txt
pip-delete-this-directory.txt

# Unit test / coverage reports
htmlcov/
.tox/
.coverage
.coverage.*
.cache
nosetests.xml
coverage.xml
*.cover
.hypothesis/
.pytest_cache/

# Translations
*.mo
*.pot

# Django stuff:
*.log
local_settings.py
db.sqlite3

# Flask stuff:
instance/
.webassets-cache

# Scrapy stuff:
.scrapy

# Sphinx documentation
docs/_build/

# PyBuilder
target/

# Jupyter Notebook
.ipynb_checkpoints

# pyenv
.python-version

# celery beat schedule file
celerybeat-schedule

# SageMath parsed files
*.sage.py

# Environments
.env
.venv
env/
venv/
ENV/
env.bak/
venv.bak/

# Spyder project settings
.spyderproject
.spyproject

# Rope project settings
.ropeproject

# mkdocs documentation
/site

# mypy
.mypy_cache/
50 changes: 50 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
.. image:: https://img.shields.io/badge/licence-AGPL--3-blue.svg
:target: http://www.gnu.org/licenses/agpl-3.0-standalone.html
:alt: License: AGPL-3

=========================
DIAN - Electronic invoice
=========================q

This module allows to send electronic invoices to DIAN

Usage
=====

TODO

How to contribute
=================
Contributions are more than welcome!
Please, read the following steps how to contribute.

- First, open an issue in the repository, using the [bug tracker][1], you
should start describing the feature you would like to make, the bug you
want to fix or other ideas you have.

- It's recommended to wait for feedback before continuing to next steps.

- Fork the project in your repository and create a branch with the new
feature or fix.

- Commit your changes in that branch, writing the code following the
[OCA Guidelines][2]

- Open a pull request. Write a good description and
title, so everybody will know what is fixed/improved.

- After we'll review them. Finally, your contribution will be merged.


Credits
=======


Contributors
------------

* Susana Vázquez <[email protected]>


[1]: https://github.com/svazquezco/l10n_co_electronic_invoice/issues
[2]: https://github.com/OCA/odoo-community.org/blob/master/website/Contribution/CONTRIBUTING.rst

0 comments on commit 66a7178

Please sign in to comment.