Giter VIP home page Giter VIP logo

templates's Introduction

Template

This is a tempalte with examples on how to write a README file

Preparation

Explain which software or requirements we need, before proceeding to the instalation.

  • Step 1
  • Step 2
    • Aditional steps
      • More aditional Steps
  • Step 3

Installation

Every command to execute has to be printed in a textbox like the one down

apt install example

If it requires an explanation, under each textbox, a description can be made

Usage

Feature 1

example code to execute

Feature 2

example 2 code to execute

API calls

METHOD Resource Input Response
POST
PUT
DELETE
GET

API Objects

Object 1

Field Type Description
{
    "valor": "valor",
    "valor2": 5
}

Contributing

Insert here contribution policy

License

MIT License

Copyright (c) 2023 Moffinguer

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

templates's People

Contributors

moffinguer avatar

Watchers

 avatar

templates's Issues

New Formatter tools for Python

Accept new tools to format python code:

  • Black
  • Pybetter
  • Unify
  • Eradicate
  • Teyit
  • Isort
  • Ssort

They have to complement each other, and work stand alone to do their job

Linter for Java

  • CheckStyle
  • CLang-Formatter

An analysis is required to specify which params would fit initially better

Linter for Javascript

  • EsLint + ( HtmlEsLint, CSSEsLint )
  • CLang-Formatter
    An analysis is required to check which parameters are better initially

Linter for Python

  • PyLint
  • Autopep8

An analysis is required to check which parameters are better initially

Refactor pre-commit

Given the actual status of the hook, it's required to unify all the langs in a single one.
Points to make:

  • Move all the content of all formatters and linters into a single function, and select the correct config depending on the lang
  • The function to ignore files doesn't work as expected. Check it
  • Logfile var is being rewritten if there are several checkers ON. Revise it

Shell Tools

Configure Formatter and Linter for Shell scripts:

  • Formatter: shfmt
  • Linter: shellcheck

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.