Contribution Guide

Deskulpt welcomes all sorts of contributions, no matter how large or small!

Open Development

The Deskulpt project is hosted on GitHub: https://github.com/CSCI-SHU-410-SE-Project/Deskulpt. We are a community based on openness and friendly, didactic discussions. We aspire to value everyones' contributions, and we are committed to providing a safe and welcoming environment for all. Decision-making is based on technical merit and concensus. Please refer to our Code of Conduct for more information.

Bug Reports

Please report bugs to the issue tracker after you have searched for previous issues and found no results. Please be as descriptive as possible. If applicable, please include your environment, software versions, widget codes, etc. so that the issue can be more easily reproducible.

Feature Requests

Before requesting new features, please make sure to look through the issue tracker as your request may already exist. If it does not, submit an issue with title prefixed with [feat]. Please be as descriptive as possible, including necessary illustrations if applicable.

Submitting Pull Requests

We accept pull requests for bug fixes, improvements, new features, and documentation. Pull requests should be made from your own fork of the Deskulpt project towards the main branch, with the "Allow edits by maintainers" option checked. All pull requests need to pass our contiguous integration (CI) and go through the same review process. If your pull request is not yet ready for review, please mark it as a draft. Please move on read the other relevant sections in our contribution guide before you start.