Skip to content

Latest commit

 

History

History
85 lines (64 loc) · 5.18 KB

CONTRIBUTING.md

File metadata and controls

85 lines (64 loc) · 5.18 KB
Raw

🇪🇸 Contribuyendo al proyecto Angular Leaflet Map

¡Nos encanta tu aporte! Queremos que las contribuciones a este proyecto sean lo más fáciles y transparentes posible, como por ejemplo:

  • Reportar errores
  • Discutir el estado actual del código.
  • Presentar una propuesta de corrección de una incidencia.
  • Sugerir nuevas características.
  • Implementar nuevas características.
  • Hacer traducciones.

Desarrollamos con Github

Usamos github para alojar el código, rastrear problemas y solicitudes de funciones, así como aceptar solicitudes de extracción.

Usamos Github Flow, por lo que todos los cambios de código ocurren a través de solicitudes de extracción

Las solicitudes de extracción son la mejor manera de proponer cambios en el código base (usamos Github Flow). Damos la bienvenida activamente a sus solicitudes de extracción:

  1. Bifurque el repositorio y cree su rama desde develop.
  2. Si ha agregado código que debe probarse, agregue pruebas.
  3. Si ha cambiado las API, actualice la documentación.
  4. Asegúrese de que el conjunto de pruebas pase.
  5. Cree un Stackblitz [demostración de la plantilla] (https://stackblitz.com/edit/angular-leaflet-map-basic?file=src%2Fapp%2Fapp.component.ts) para mostrar la nueva funcionalidad. Puedes construir sobre estos ejemplos ya creados.
  6. Asegúrese de que su código se desvanezca.
  7. Escriba un buen mensaje de compromiso para Gitflow comete mejores prácticas para escribir mensajes
  8. ¡Emita esa solicitud de extracción!

Pendiente de seguir añadiendo información...

🇬🇧 Contributing to Angular Leaflet Map

We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's:

  • Reporting a bug
  • Discussing the current state of the code
  • Submitting a fix
  • Proposing new features
  • Becoming a maintainer(code)

We Develop with Github

We use github to host code, to track issues and feature requests, as well as accept pull requests.

We Use Github Flow, So All Code Changes Happen Through Pull Requests

Pull requests are the best way to propose changes to the codebase (we use Github Flow). We actively welcome your pull requests:

  1. Fork the repo and create your branch from develop.
  2. If you've added code that should be tested, add tests.
  3. If you've changed APIs, update the documentation.
  4. Ensure the test suite passes.
  5. Create a Stackblitz demo from the template to showcase the new functionality. You can build on these examples already created.
  6. Make sure your code lints.
  7. Write good commit message to Gitflow commit beest practices to write messages
  8. Issue that pull request!

Any contributions you make will be under the MIT Software License

In short, when you submit code changes, your submissions are understood to be under the same MIT License that covers the project. Feel free to contact the maintainers if that's a concern.

Report bugs using Github's issues

We use GitHub issues to track public bugs. Report a bug by opening a new issue; it's that easy!

Write bug reports with detail, background, and sample code

This is an example of a bug report I wrote, and I think it's not a bad model. Here's another example from Craig Hockenberry, an app developer whom I greatly respect.

Great Bug Reports tend to have:

  • A quick summary and/or background
  • Steps to reproduce
    • Be specific!
    • Give sample code if you can. My stackoverflow question includes sample code that anyone with a base R setup can run to reproduce what I was seeing
  • What you expected would happen
  • What actually happens
  • Notes (possibly including why you think this might be happening, or stuff you tried that didn't work)

People love thorough bug reports. I'm not even kidding.

Use a Consistent Coding Style

I'm again borrowing these from Facebook's Guidelines

  • 2 spaces for indentation rather than tabs
  • You can try running npm run lint for style unification

License

By contributing, you agree that your contributions will be licensed under its MIT License.

References

This document was adapted from the open-source contribution guidelines for Facebook's Draft