From b183f0311b220e08beac8946f35a837f375fe8bc Mon Sep 17 00:00:00 2001 From: Storm Dragon Date: Thu, 17 Oct 2024 17:50:50 -0400 Subject: [PATCH] Updated the HACKING file. --- HACKING | 47 ++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 46 insertions(+), 1 deletion(-) diff --git a/HACKING b/HACKING index ed58b56..2f3e8c5 100644 --- a/HACKING +++ b/HACKING @@ -1 +1,46 @@ -Please contact the MAINTAINERS before making changes to Cthulhu. \ No newline at end of file +Welcome to Cthulhu + +We are excited to have you here and welcome your contributions to the Cthulhu screen reader project! This project is a fork of Orca, with a focus on creating an open and collaborative community where contributions are encouraged. + + +How to Contribute + +If you have direct access, please create a branch. After making changes, be sure to thoroughly test, then merge to the master branch. If you do not have direct access, you can send contributions via email. + + +Submitting Changes via Email + +1. **Fork or Clone the Repository** + - Clone the repository locally: + ```bash + git clone https://git.stormux.org/storm/cthulhu + ``` + + - Make the changes you want to contribute. + +2. **Format Your Changes for Submission** + - Use `git format-patch` to create patch files for your changes: + ```bash + git format-patch origin/master + ``` + + - This will generate `.patch` files for your commits, which can be emailed to us. + +3. **Email Your Patches** + - Once your patches are ready, send them via email to: + **storm_dragon on the stormux.org domain** + - In your email, briefly explain the changes and improvements made in the patch. + + +Contribution Guidelines + +- **Respect Coding Standards**: Please follow the existing coding style and structure where possible. Exceptions exist of course if it is a refactor. +- **Write Clear Commit Messages**: Ensure each commit includes a clear and concise message that explains what has been changed and why. +- **Be Open to Feedback**: questions may be asked or changes suggested to ensure the contribution aligns with the project. + + +Get Involved in the Community + +Please join the Stormux email list. You can do so at https://stormux.org. Also, you can talk to us on irc at irc.stormux.org #stormux. + +Thank you for your interest in contributing to Cthulhu! Together we can make an awesome screen reader.