Contributing
Reporting an Issue
Issues may be posted through GitHub Issues. Before reporting an issue, please look over existing issues for any bugs that might be similar or the same as your own, duplicate issues will be closed. Ensure your issue also hasn't been solved in a new version. Also ensure you have read the docs and are using a supported deployment method, as other deployment methods might not be as readily supported. In order to better help users of the application, issue reports must include:
- A clear title
- The version your issue was found on
- Steps to reproduce
- Expected behavior
- Actual behavior
Additionally you may provide the following to expedite your support:
- A live link where your issue can be reproduced (on the demo, on your own hosted instance)
- A video of your issue happening
Requesting a Feature
Feature requests may be posted through GitHub Issues. Feature requests are pulled into milestones at will, there is no inherit ordering in which features will be worked.
Code of Conduct
- Using welcoming and inclusive language
- Being respectful of differing viewpoints and experiences
- Gracefully accepting constructive criticism
- Focusing on what is best for the community
- Showing empathy towards other community members
Local Development
Local development is done using docker compose
- Pull the repo:
git clone git@github.com:mdshack/shotshare.git - Change to the ShotShare directory:
cd shotshare - Install dependencies:
composer install; npm install - Build frontend:
npm run build - Start docker compose:
docker compose up