Skip to content

Latest commit

 

History

History
137 lines (102 loc) · 4.75 KB

CONTRIBUTING.md

File metadata and controls

137 lines (102 loc) · 4.75 KB

Contributing to Esquite

🌽🥳 Thanks for taking the time too contribute! 🥳🌽

The Esquite framework is a free software that welcomes contributions of many forms. The following is a set of guidelines for contributing to the framework, which is developed by the Elotl Community. These are mostly guidelines, not rules. Feel free to propose changes to this document in a pull request

Code of conduct

We invite you keep the Elotl Community open and inclusive. Please read and follow our Code of conduct

I don't want to read this whole thing, I just have a question

If you have any question about the source code or any other topic you can contact us in the following ways:

Technical Contribution

About the project

If you want to introduce a new feature or suggest code changes you need to know the project's structure. The project is made with django and elasticsearch as backend and boostrap, javascript and css as frontend. You can find an in-detail description of the project's structure in the docs

Code style guide

  • We use an .editorconfig file that you can use with your text editor installing a plugin. This helps us keep the coding style consistent. Installation guides here.
  • We follow the pep 8 style guide for python code for python code.
  • The docstrings follow the Sphinx format
    • Sphinx is the python documentation generator that we currently use to made our docs.

Contribute with code

  1. Fork this repo
  2. Clone in your machine
  3. Create a new branch where you work for the issue will go: git checkout -b fix/issue-1234
  4. Make your changes
  5. If you fixed the issue commit
  6. Push the branch on your fork and create a pull request
    • Include the issue number fix(bug-1234): Fix some buggy code :p

Making a Pull Request

  • TODO... explicit workflow of commits
  • Consider using the pull request template
  • If you don't want to use the template please consider at least these points
    • A short descriptive title of the changes
    • A summary of the features you are proposing or the bugs you are correcting
    • A mention to people that can review your code

Non-technical Contributions

Report a bug via issues

  • Reporting any problem, issue or bug can make us improve Esquite.

  • To take it easier for us to resolve bugs and issues consider to provide these information:

    1. Describe the bug
    2. Steps to reproduce
    3. Expected behavior
    4. Screenshots (if any)
    5. Platform used
      • OS
      • Device
      • Browser
      • Version
    6. Additional context

  • We provide a template for issues that you can use. Consider using it.

Suggest a feature or enhancement

  • Is your feature request related to a problem? Please describe.
  • Describe the solution you'd like.
  • Describe alternatives you've considered.
  • Additional context.

Corpus compilation

Part of our labor it's to enable NLP technologies through datasets like Tsu̱nkua. To achieve this we need to collect monolingual or bilingual corpora in different Mexican languages.

You can help us identifying, digitalizing and preprocessing books and materials with monolingual or multilingual content. Currently we have open projects in the next languages:

  • Spanish-Náhuatl
  • Spanish-Otomí
  • Spanish-Mixteco
  • Spanish-O'dam

However, we are in constant search of material in any languages pairs spoken in Mexico. Are you interested? contact us 😁

Diffusion

In addition to the task related to research and development of technologies we maintain outreach activities of didactic material, events, initiatives, calls for proposals, related with minority languages. Be part of our community and help us to monitor relevant information to disseminate it through our social networks.

Our blog is also open to collaborations related with technologies and languages spoken in Mexico.

Sponsor

Todo...

Thank you very much 💛 💛 💛

Elotl Team 🌽