ayo/mcfly
ayo/mcfly
1
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

chore: update CONTRIBUTING guide

Browse source
This commit is contained in:
Ayo Ayco 2025-02-10 22:31:30 +01:00
parent f87d5ddd56
commit 3a1c9f773f
1 changed files with 53 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

61
CONTRIBUTING.md
View file

@ -1,12 +1,57 @@
# CONTRIBUTING # CONTRIBUTING
This file contains the contributing guide for our project. Hi, and thanks for your intereset to contribute to **McFly**! 🎉
To contribute to our project, please follow these steps: This is the best place to start if you want to contribute code to the project.
1. Fork the repository on [SourceHut](https://ayco.io/sh/mcfly). ## Report issues or request features
2. Clone the forked repository to your local machine.
3. Create a new branch for your changes. To open issues or feature requests, see our [issue tracker](https://todo.sr.ht/~ayoayco/mcfly). You can also send them via email to [`~ayoayco/mcfly@todo.sr.ht`](mailto:~ayoayco/mcfly@todo.sr.ht).
4. Make your changes and commit them with a descriptive message.
5. Push your changes to your forked repository. ## Participate in discussions
6. Create a pull request to merge your changes into the main repository.
To open new or participate on existing discussions, see our [mcfly-discussions](https://lists.sr.ht/~ayoayco/mcfly-discussions) mailing list.
## Contribute Code
We use `git` and `email` here -- it is actually fun!
To get started, setup [git send-email](https://git-send-email.io).
After setting up `git send-email` you can now follow the steps below to start hacking:
1. Clone the repository to your local machine, then go into the project directory:
```bash
$ git clone https://git.sr.ht/~ayoayco/mcfly
$ cd mcfly
```
2. Create a new branch for your changes:
```bash
git checkout -b my-branch
```
3. Make your changes, and then commit them with a descriptive message using [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/):
```bash
git commit -m "feat(core): implement server-side rendering"
```
4. Use `git send-email` to send a patch:
```bash
git send-email --to="~ayoayco/mcfly-patches@lists.sr.ht" HEAD^
```
> The `HEAD^` bit is a reference to the latest commit, which will be added to your patch. This could be a range of commits as well if you have mutiple commits.
5. Wait for a response from us whether the patch needs rework... or a notification if it gets merged!
> As a summary, we use `git` and `email` to collaborate on McFly. You have to set up [git send-email](https://git-send-email.io) and send patches via email. :)
## Need help?
If something needs clarification, don't hesitate to reach out to me via email [`ayo@ayco.io`](mailto:ayo@ayco.io). Thanks! :)