Skip to content

Latest commit

 

History

History
71 lines (50 loc) · 2.57 KB

CONTRIBUTING.md

File metadata and controls

71 lines (50 loc) · 2.57 KB
Raw

Contributing to Timegrid

Thank you for considering contributing to Timegrid.

With the goal of building an appointment platform that people love, timegrid is specially welcoming for the following aspects:

  • UI/UX enhancement/fixes
  • Bugfixes
  • Code Coverage increase
  • Code Optimization / Refactor
  • Graphic Design enhancement
  • Localization
  • User Manual documentation
  • Technical documentation
  • API Development
  • Feature additions

Submit bug reports or feature requests

Submit pull requests

  • Fork the Timegrid repository
  • Create a new branch with the name #issue_number-Short-description
    • Example: #100-Fix-Navbar
  • Make your changes and commit
  • Check if your branch is still in sync with the repositorys master branch
  • Push your branch and create a PR against the Timegrid master branch

Some rules

To make the contribution process nice and easy for anyone, please follow some rules:

  • Each contribution (bug or feature) should have an issue on Github to have a detailed explanation.
  • Only one feature/bugfix per issue. If you want to submit more, create multiple issues.
  • Only one feature/bugfix per PR (Pull Request). Split more changes into multiple PRs.

Coding Style

Try to follow the PSR-2 guidlines

Up-for-grabs Issues

Jumping in for first time? I have flagged the easy ones for you.

The idea is a great way to get started with a project, or to help share the load of working on open source projects.

Questions / Doubts

Drop me a line and I'll be happy to help.

You may also subscribe the dev newsletter.

Reporting Issues

For submitting an issue, please follow the steps below:

  1. Check in open and closed issues if your inquiry was reported before by somebody else.
  2. Nothing found?, Go ahead with the following template for providing required info

Template

Type Of Issue: [Bug|Enhancement|Feature Request|Question]
Timegrid environment: [online demo|local install]
Browser Name and Version: 
Server Operating System: