diff --git a/README.md b/README.md index 0bd2fa5..bfb3752 100644 --- a/README.md +++ b/README.md @@ -62,11 +62,37 @@ guile -L . guile-stash.scm --target=/path/to/target --package-dir=/path/to/sourc ``` ## Contributing -Contributions to Guile-Stash are welcome. Please feel free to fork the repository, make your changes, and submit a patch or topic for discussion to our mail list [~glenneth/guile-stash@lists.sr.ht](https://lists.sr.ht/~glenneth/guile-stash). +Thank you for considering contributing to this project! Here's how you can get involved: + +### Pull Requests + +1. **Fork the repository on Codeberg**: You can find the "Fork" button on the top-right of the project page. +2. **Clone your fork** to your local machine: +```bash + git clone https://codeberg.org/your-username/your-repo.git + cd your-repo +``` +3. **Create a new branch** for your changes: +```bash +git checkout -b feature/your-feature-name +``` +4. **Make your changes** and **commit them** with a clear message: +```bash +git add . +git commit -m "Description of your changes" +``` +5. **Push the changes** to your fork: +```bash +git push origin feature/your-feature-name +``` +6. **Open a pull request** from your branch on Codeberg. + +Contributions to Guile-Stash are welcome. Please feel free to fork the repository, make your changes, and submit a patch or topic for discussion. +Your pull request will be reviewed, and feedback might be provided if necessary. Once approved, it will be merged into the main project. ## License -Guile-Stash is licensed under the MIT License. For more details, see the [LICENSE](https://git.sr.ht/~glenneth/guile-stash/tree/master/item/LICENSE) file for details. +Guile-Stash is licensed under the MIT License. For more details, see the [LICENSE](https://codeberg.org/glenneth/stash/src/branch/dev/LICENSE) file for details. This README provides a starting point. Feel free to expand it with more detailed examples, configuration options, or a more comprehensive guide on contributing to the project.