Skip to content

Latest commit

 

History

History
29 lines (18 loc) · 1.63 KB

CONTRIBUTING.md

File metadata and controls

29 lines (18 loc) · 1.63 KB

Contributing

Introduction

Thank you for your interest in contributing to this project! We are always looking for ways to improve, and we appreciate any contributions you can make. This document will guide you through the process.

Getting Started

  1. Make sure you have a GitHub account
  2. Submit a comment on the issue you want to work on. This will let us know you are working on it.
  3. Fork the repository on GitHub
  4. Clone the project to your own machine
  5. Commit changes to your own branch
  6. Push your work back up to your fork
  7. Submit a Pull request so that we can review your changes

Please make pull requests to the main branch (which is the default). Once merged, contributors can test updates on linkfree.fly.dev. If everything looks good, we can sync the new changes to the production branch which deploys to linkfree.ckt.im.

Development environment

This project is written in php and is inteded to work with the php development server. After cloning the repository, just run ``cd src && php -S localhost:8000` to set up your own local version acessible from http://localhost:8000 in your browser. You can also test with docker, but it is less convenient for development.

Code of Conduct

This project is committed to a welcoming and inclusive environment. Please be respectful of all contributors, regardless of their background or experience.

Reporting Issues and Requesting Features

Please report any bugs or issues you encounter using the issue tracker. New feature requests are also welcome. Be sure to search for similar existing issues before creating a new one.