From 5de62ea01ec9e015f6f2a885cf31a772c119608d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Iv=C3=A1n=20Cea=20Fontenla?= Date: Mon, 22 Jul 2024 23:39:37 +0200 Subject: [PATCH 1/5] Create CONTRIBUTING.md --- CONTRIBUTING.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..d387ce5 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,22 @@ +# How to contribute + +## Before contributing, keep in mind: +- This app is still in **early development stage** +- Somewhat big changes may be done without notice, as the code grows and needs to be reorganized +- Features may be added in no specific order +- For those reasons, the existing issues are not organized in time, and may have hidden dependencies with other issues + +## Working on an issue +To avoid conflicts in this stage, and to avoid frustration or wasting time: +- Comment on the issues you want to work on, and wait for confirmation. Ask for specific details, as issues are not explained in depth. +
It _may or may not_ be planned to be done yet, and it _may_ be just an idea without real product definition +- Work on it and submit a PR. If there are visual changes, consider adding a screenshot +- Wait for review. I'll usually get notified and check it in between a day and a week +- After iterating and solving comments, it will be manually merged by a collaborator + +## How to report a bug +The short answer is: You don't! Unless it's some kind of uncaught exception you found in there. +In which case feel free to open an issue, and tag it with the "bug" label, with the full stack trace, an explanation of what happen and, if possible, a reproduction method. + +As the project is still in an early stage, there will be multiple bugs. Some will have an issue open, and some won't. +Unfortunately, the project evolves at a relatively slow pace, and some weird interactions may be _allowed_. From c5ea875ae271c4c0f6c4168e3354ac49fb107fe1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Iv=C3=A1n=20Cea=20Fontenla?= Date: Mon, 22 Jul 2024 23:41:34 +0200 Subject: [PATCH 2/5] Update README.md --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 9681a7e..2ef2cbc 100644 --- a/README.md +++ b/README.md @@ -9,6 +9,8 @@ The multiplayer system is similar to the one in [Agar.io](https://agar.io/), whe The name and domain, `Hammerfight.io`, is a homage to both games. +> 👀 Want to contribute? Check [the contribution guidelines](./CONTRIBUTING.md) + ## How to run > For cloud deployments, check [Cloud deployment](#cloud-deployment). From a8991c53b343d1cadeb55a5c143a6d6e6a1eab78 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Iv=C3=A1n=20Cea=20Fontenla?= Date: Mon, 22 Jul 2024 23:56:06 +0200 Subject: [PATCH 3/5] Update CONTRIBUTING.md --- CONTRIBUTING.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d387ce5..3f7d036 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -14,6 +14,10 @@ To avoid conflicts in this stage, and to avoid frustration or wasting time: - Wait for review. I'll usually get notified and check it in between a day and a week - After iterating and solving comments, it will be manually merged by a collaborator +> ❗ The app and branch is expected to have been launched, and the feature, manually tested. +>
❗ Opening a PR that doesn't work may be considered spam, and flagged as such. +>

🕒 We are all human, and we all make mistakes. This is just a reminder to avoid opening low-effort PRs that waste collaborators time. + ## How to report a bug The short answer is: You don't! Unless it's some kind of uncaught exception you found in there. In which case feel free to open an issue, and tag it with the "bug" label, with the full stack trace, an explanation of what happen and, if possible, a reproduction method. From ccb7799c4afe96c7c3f998bb14cf2f16527702cc Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Iv=C3=A1n=20Cea=20Fontenla?= Date: Tue, 23 Jul 2024 00:36:49 +0200 Subject: [PATCH 4/5] Add labels explanation to CONTRIBUTING.md --- CONTRIBUTING.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 3f7d036..071a944 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -18,6 +18,12 @@ To avoid conflicts in this stage, and to avoid frustration or wasting time: >
❗ Opening a PR that doesn't work may be considered spam, and flagged as such. >

🕒 We are all human, and we all make mistakes. This is just a reminder to avoid opening low-effort PRs that waste collaborators time. +### Understanding issues: Labels +There are some sets of labels you will see in the issues, usually one of each: +- `:`: Labels that define which components are mainly related with the issue +- `!`: Labels that define whether the issue can be assigned, if it's not ready yet, if it's a private issue, etc +- ``: Labels that define the kind of issue (bug, enhancement...). There may be other unrelated topics too + ## How to report a bug The short answer is: You don't! Unless it's some kind of uncaught exception you found in there. In which case feel free to open an issue, and tag it with the "bug" label, with the full stack trace, an explanation of what happen and, if possible, a reproduction method. From 5d5c32c65bb4fc74f85fd860b5bacc79b254e7db Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Iv=C3=A1n=20Cea=20Fontenla?= Date: Tue, 23 Jul 2024 00:48:47 +0200 Subject: [PATCH 5/5] Update CONTRIBUTING.md --- CONTRIBUTING.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 071a944..243e036 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -21,7 +21,8 @@ To avoid conflicts in this stage, and to avoid frustration or wasting time: ### Understanding issues: Labels There are some sets of labels you will see in the issues, usually one of each: - `:`: Labels that define which components are mainly related with the issue -- `!`: Labels that define whether the issue can be assigned, if it's not ready yet, if it's a private issue, etc +- `!`: Labels that define whether the issue can be assigned, if it's not ready yet, if it's a private issue, etc. +
If an issue lacks this label, use your best judgement. It may have been forgotten, or it may be too convoluted to define. - ``: Labels that define the kind of issue (bug, enhancement...). There may be other unrelated topics too ## How to report a bug