Skip to content

Latest commit

 

History

History
47 lines (38 loc) · 2.09 KB

CONTRIBUTING.md

File metadata and controls

47 lines (38 loc) · 2.09 KB
Raw

Introduction

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 or a feature
  • Proposing new features
  • Becoming a maintainer

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 .
  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. Make sure your code lints.
  6. Issue that pull request!

Git templates:

  1. branch naminge: You should respect this branch naming pattern
    • master-[issue-number]-[subject]
  2. issues:
    • you can use provided issues templates according to the kind of issue
  3. pull requests:
    • As issues template is automaticcly generated when you submit one

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!

Use issues templates relating to what you need

Use a Consistent Coding Style

Backend:

  • Backend is a coded with spring boot framework. For code style rules, we use Eclipse default format.

Frontend:

  • Frontend is coded in react js, we should respect ECMAscript

License

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