Updating information for Contributors #3874

DeNic0la · 2023-09-30T14:43:12Z

I updated the English part of CONTRIBUTING.md, would appreciate feedback before doing the German version

manuelmeister

Very cool! This should help get things started.

Could you please check the text with a grammar checker (like DeepL write). Nouns usually don't start with a capital letter. Only the first letter of the sentence and "proper" nouns like specific things, people and places start with a capital letter (like Switzerland, Google & Manuel Meister).

carlobeltrame

Many words are started with an uppercase letter, please correct those.

CONTRIBUTING.md

manuelmeister

Thank you! I have tried to improve some aspects that were still a bit unclear to me.

CONTRIBUTING.md

DeNic0la · 2023-10-21T20:18:11Z

I added a `Database` and `Discussion` chapter.

I added Emojis

You can easily view them on my repository or download this JetBrains extension (tested) or a vs code extension. I am aware that not everyone is a fan of emojis. IMO they make the file look more friendly and inviting. I am convinced the overall effect of those emojis is positive so I added them.

In the `Workflow` chapter I added suggestions, did the spellcheck and made the following modifications:

Refactor checklist: use title, descriptions and add explanation
Code Formatting
- Add print, pdf and e2e commands
- List commands for Lint: show docker compose exec vs run and explain
- Add pre-commit.sh: Example Git-Hook
- Stuff is now collapsable
Use $(git config user.name) instead of 'your-username' to simplify the 'happy flow'

I split the file into `CONTRIBUTING.md` and `CONTRIBUTING_DE.md` and here are my reasons:

Spellcheck with one Language per file
Side-by-side comparison to ensure both files contain the same information
When scrolling through the file / Headings / Structure it feels like a 'complete' file
Possibility to translate (with deepl API?) files like the ./translations

I am aware that this is very biased and can all be summarized as 'I just like it more', that's why I am asking for approval/permission. Note that the German version is not up to date.

🏁 IMO the English version is complete for the moment _{(meaning ready to be merged).}

🚧 If you have any topics the CONTRIBUTING.md should address but doesn't please let me know.
✔️ If you agree that the English version is ready for merge and agree (or at least accept/tolerate) my decision to split by language please let me know with an Approval-Review-Thingy

👷 If this Draft-PR gets approved I will update the German version and once finished mark this as ready for merge (the 'not-draft-thingy') which means you will get a second chance to review before merge. I therefore ask you to approve this Draft if your only critique is a (or multiple) misspelt word(s) and you generally approve the content, I will still fix my mistakes (if you point them out) and rerun some spellchecker before marking this as ready. By approving based on content I hope to add the German version sooner and work more efficiently.

@manuelmeister @carlobeltrame

BacLuc · 2023-10-22T09:42:12Z

CONTRIBUTING.md


 We use a triangular git workflow. This means that all changes are first pushed to a contributor's fork of the repository, and then the changes are merged into the main fork via a pull request. In practice, setting up this workflow looks as follows:

-1. Fork the main repository onto your GitHub account. Let's say your GitHub account is called `your-username`.
+1. Fork the main repository onto your GitHub account. To use the commands your configured git `user.name` must be exactly your git user name. 


To use the commands your configured git user.name must be exactly your git user name.
Is this a requirement by us?

Github just takes the user.name used in the commit.

This is one of my bolder choices in this PR. Here is what I was thinking: the people who lack the technical knowledge to set up a git repo using a forked repo are the main concerns here. When this was the case for me I used Git over GUI Tools (Login to GitHub in Intellij, GitHub Desktop) and my Git username was always set to my GitHub username. I made the assumption that most people have git username = GitHub username (I call such cases 'happy flow', not sure if it's a common term).

In the happy flow, you can now execute every command as it is (for example using IntelliJ or copy-paste-execute) and there are no modifications needed.

If you use a different git username the only thing that changed compared to the previous version is the text you are replacing. You still need to replace text in the exact same places. Instead of replacing your-username (I believe that was the previous placeholder) you need to replace $(git config user.name). This is a bit more confusing than before, I would agree. I made the assumption that people who need to replace this and don't fall into the happy flow are a minority with the technical understanding to set this up without documentation.

There is no requirement to have your git username match your GitHub username, this is a requirement for the happy flow. This could probably be better written.

This might be an impactful change but I am convinced it will make the setup more efficient overall. Do you want me to clarify in the documentation or revert my changes?

I like the idea of describing the happy flow for beginners, and leave experienced git gurus to do things their way. Maybe you could just change "must" (and "need to" in the paragraph below) to "should", and it'll sound less harsh while still being strongly suggestive?

CONTRIBUTING.md

pre-commit.sh

CONTRIBUTING.md

carlobeltrame

Thanks, this is coming along great!

carlobeltrame · 2023-10-22T10:18:10Z

CONTRIBUTING.md


-<em lang="de">Die <a href="#deutsch">deutsche Übersetzung</a> findest du weiter unten.</em>
+# English :milky_way:


I think we can remove this heading now, would you agree? It is clear from the content of the document that the language is English.

I agree. This would also reduce the heading levels which would serve the readability and visual hierarchy!
Which would also need to be adjusted

carlobeltrame · 2023-10-22T10:35:07Z

CONTRIBUTING_DE.md

@@ -0,0 +1,71 @@
+# Mitarbeit


I like the split into two different files. Can you also adjust the link in the German part of the README.md, and ideally also in the contribution guide on the landing page (https://github.com/ecamp/ecamp-site/blob/main/src/content/pages/contribution.de.md?plain=1#L28)

carlobeltrame · 2023-10-22T10:39:03Z

CONTRIBUTING.md

+### Labels :label:
+Issues are marked with labels and some of them are not self-explanatory and are explained here:
+- **Type-Labels**:
+  Type labels follow the `type: *` format with the options `Frontend`, `Print`, `Deployment` & `API` the architecture for those are partially documented in the [wiki](https://github.com/ecamp/ecamp3/wiki/architecture-frontend)


Rather than describing semi-formally how we construct these labels, how about just listing the examples type: Frontend, type: API, etc.?

carlobeltrame · 2023-11-10T20:09:57Z

CONTRIBUTING.md

-### [Code of conduct](https://www.ecamp3.ch/en/code-of-conduct)
+## Workflow :gear:
+This is a basic overview of the workflow, i.e. how we work with the code of eCamp v3. More information about how to set up a development environment on your computer is in the [wiki](https://github.com/ecamp/ecamp3/wiki/installation).
+If something about the setup is unclear, or you run into an error, there are [discussions](https://github.com/ecamp/ecamp3/discussions) on GitHub for you to ask questions and ask for help. :computer:


Replace this sentence with a Discord invite link: https://discord.gg/tdwtRytV6P
We are sunsetting discussions for now and handling setup support on Discord.

carlobeltrame · 2023-11-10T20:10:49Z

CONTRIBUTING.md

+- **Type-Labels**:
+  Type labels follow the `type: *` format with the options `Frontend`, `Print`, `Deployment` & `API` the architecture for those are partially documented in the [wiki](https://github.com/ecamp/ecamp3/wiki/architecture-frontend)
+- **Needs prototype**: :bulb: If you have an idea how to solve this issue: we'd like to see it. This issue needs a prototype before actual implementation begins since the specifications are somewhat vague. A prototype can be many things, whether your prototype is a sketch, mockup, partial implementation or something else is up to you.
+- **Good first issue**: :green_heart: Beginner friendly issues.


Move this up to the first position in the list?

carlobeltrame · 2023-11-10T20:27:55Z

CONTRIBUTING.md

+Following it will not only enhance the quality and consistency of your contributions:sparkles:  but also fast-track the review process. :rocket:
+
+
+- [x] **Sync with Central Repository:** :arrows_counterclockwise: Ensure your fork is up to date with the central repository, facilitating a smooth merge.


Maybe link to github documentation on how to do that? https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/syncing-a-fork

carlobeltrame · 2023-11-10T20:28:44Z

CONTRIBUTING.md

+- [x] **Spelling:** :abc: Ensure that the changes are spell checked
+- [x] **Significant Changes:** :mag_right: Confirm that every modified file contributes meaningful content, steering clear of inconsequential changes like mere whitespace adjustments.
+- [x] **Testing:** :test_tube: Write tests for any new features, and update existing ones if you've made changes to functionalities.
+- [x] **Language & Spelling:** :book: Use English for all variable names, class names, functions, comments, etc., and ensure that all added content has been spellchecked.


Spelling is already mentioned above, remove either one

Those two mean slightly different things. The first one is documentation (which I don't think needs to be English) and the other one is code, like variable names (which I do think needs to be (mostly) English).
However, I must admit that this adds no value and is just overly complicated so I will "merge" them.

carlobeltrame · 2023-11-10T20:30:16Z

CONTRIBUTING.md

+including edge cases, are effectively covered.
+
+### Recommended Test User :bust_in_silhouette:
+To begin with, utilize the `test@example.com / test` user credentials. 


Suggested change

To begin with, utilize the `test@example.com / test` user credentials.

To start out, utilize the `test@example.com / test` user credentials.

I think "To begin with" means more like "Überhaupt mal"

carlobeltrame · 2023-11-10T20:31:02Z

CONTRIBUTING.md

+When reporting an issue or bug, consider referencing a specific example from 'Dev-Data'. 
+Since the data, including IDs, remains consistent, it allows everyone to easily replicate and understand the behavior you're highlighting.
+
+## Discussions :speech_balloon:


Replace with Discord

pre-commit.sh

…in-2.x chore(deps): update dependency @sentry/webpack-plugin to v2.10.0

chore(deps): update dependency cypress to v13.5.0

fix(deps): update dependency deepl-node to v1.11.0

fix(deps): update dependency v-resize-observer to v2.1.0

…s-3.x chore(deps): update pulumi/pulumi-nodejs docker tag to v3.93.0

fix(deps): update symfony packages

…onorepo fix(deps): update sentry-javascript monorepo to v7.80.0

chore(deps): update dependency php to v8.2.12

Co-authored-by: Bacluc <lucius.bachmann@gmx.ch>

Co-authored-by: Carlo Beltrame <carlo@beltra.me>

…to contribution-documentation

sync line numbers add Discord Join Banners

BacLuc · 2024-01-02T09:51:59Z

Do we still need this pr after #4204?

DeNic0la · 2024-01-06T23:41:37Z

Do we still need this pr after #4204?

Nope sorry, I forgot

manuelmeister requested changes Sep 30, 2023

View reviewed changes

carlobeltrame requested changes Sep 30, 2023

View reviewed changes

CONTRIBUTING.md Outdated Show resolved Hide resolved

CONTRIBUTING.md Outdated Show resolved Hide resolved

CONTRIBUTING.md Outdated Show resolved Hide resolved

CONTRIBUTING.md Outdated Show resolved Hide resolved

DeNic0la requested review from carlobeltrame and manuelmeister September 30, 2023 22:25

carlobeltrame reviewed Oct 1, 2023

View reviewed changes

CONTRIBUTING.md Outdated Show resolved Hide resolved

manuelmeister requested changes Oct 14, 2023

View reviewed changes

CONTRIBUTING.md Outdated Show resolved Hide resolved

CONTRIBUTING.md Outdated Show resolved Hide resolved

DeNic0la requested review from carlobeltrame and manuelmeister October 21, 2023 20:18

BacLuc reviewed Oct 22, 2023

View reviewed changes

carlobeltrame reviewed Nov 10, 2023

View reviewed changes

renovate bot and others added 12 commits November 12, 2023 10:23

Merge pull request ecamp#4083 from ecamp/renovate/sentry-webpack-plug…

2be5137

…in-2.x chore(deps): update dependency @sentry/webpack-plugin to v2.10.0

Merge pull request ecamp#4085 from ecamp/renovate/cypress-13.x

79c2572

chore(deps): update dependency cypress to v13.5.0

Merge pull request ecamp#4087 from ecamp/renovate/deepl-node-1.x

ade750a

fix(deps): update dependency deepl-node to v1.11.0

Merge pull request ecamp#4091 from ecamp/renovate/v-resize-observer-2.x

9238e9f

fix(deps): update dependency v-resize-observer to v2.1.0

fix(deps): update dependency axios to v1.6.1

3955d78

fix(deps): update symfony packages

442bc48

chore(deps): update cypress/included docker tag to v13.5.0

53c27d8

chore(deps): update dependency lint-staged to v15.1.0

452d95b

chore(deps): update pulumi/pulumi-nodejs docker tag to v3.93.0

6c3b33d

fix(deps): update sentry-javascript monorepo to v7.80.0

ebbe0e2

renovate: only rebase when conflicted

74c3faf

Replace discussions with discord link

d33faa8

carlobeltrame mentioned this pull request Nov 12, 2023

Sync readme with contributing page on ecamp3.ch #4008

Merged

BacLuc and others added 6 commits November 12, 2023 15:21

Merge pull request ecamp#4086 from ecamp/renovate/pulumi-pulumi-nodej…

62a4b4f

…s-3.x chore(deps): update pulumi/pulumi-nodejs docker tag to v3.93.0

Merge pull request ecamp#4079 from ecamp/renovate/symfony

adc74ef

fix(deps): update symfony packages

fix(deps): update dependency @pulumi/aws to v6.8.0

764625c

Merge pull request ecamp#4092 from ecamp/renovate/sentry-javascript-m…

edecdc4

…onorepo fix(deps): update sentry-javascript monorepo to v7.80.0

chore(deps): update dependency @types/node to v20.9.0

125f55a

Merge pull request ecamp#4045 from ecamp/renovate/php-8.x

6bcdfbc

chore(deps): update dependency php to v8.2.12

DeNic0la and others added 25 commits December 5, 2023 21:13

update workflow chapter and add Database and Discussions Chapter

396636c

Split german and english into separate files

2af6161

add print fix to checklist

5ff5f60

change all bash to shell in md for consistency and zsh support

39f41c5

add pre-commit.sh example hook

b9443a5

rewrite git-setup to use git username

5ffa5e0

add emojis

e5c7058

do spellcheck and minor rewrites

8aeb9bc

remove german emoji

0420042

Update CONTRIBUTING.md

85ae1b3

Co-authored-by: Bacluc <lucius.bachmann@gmx.ch>

Update CONTRIBUTING.md

7602bf8

Co-authored-by: Bacluc <lucius.bachmann@gmx.ch>

Update CONTRIBUTING.md

abc15bb

Co-authored-by: Bacluc <lucius.bachmann@gmx.ch>

add link to github

17fdfa6

add --rm flag to docker compose run on examples

4ebf80f

Co-authored-by: Bacluc <lucius.bachmann@gmx.ch>

fix typo

391dc36

Update CONTRIBUTING.md

e3706e4

Co-authored-by: Carlo Beltrame <carlo@beltra.me>

Update pre-commit.sh

df97afa

Co-authored-by: Carlo Beltrame <carlo@beltra.me>

update based on feedback

7a6bd51

update docs based on feedback

d8191f5

update discussions to discord

e6758e8

Merge remote-tracking branch 'DeNic0la/contribution-documentation' in…

95f99f4

…to contribution-documentation

add Discord Links

2211aeb

insert server id

b91a04a

add german CONTRIBUTING_DE.md based on english CONTRIBUTING.md

0383fbc

sync line numbers add Discord Join Banners

update link to german CONTRIBUTING_DE.md version

bbc0023

This was referenced Dec 5, 2023

Contribution documentation update #4204

Merged

update references to contribution guidelines ecamp/ecamp-site#28

Closed

DeNic0la closed this Jan 6, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Updating information for Contributors #3874

Updating information for Contributors #3874

DeNic0la commented Sep 30, 2023 •

edited

Loading

manuelmeister left a comment

carlobeltrame left a comment

manuelmeister left a comment

DeNic0la commented Oct 21, 2023 •

edited

Loading

BacLuc Oct 22, 2023

DeNic0la Oct 22, 2023

carlobeltrame Nov 10, 2023

carlobeltrame left a comment

carlobeltrame Oct 22, 2023

manuelmeister Nov 18, 2023

carlobeltrame Oct 22, 2023

carlobeltrame Oct 22, 2023

carlobeltrame Nov 10, 2023

carlobeltrame Nov 10, 2023

carlobeltrame Nov 10, 2023

carlobeltrame Nov 10, 2023

DeNic0la Nov 19, 2023

carlobeltrame Nov 10, 2023

carlobeltrame Nov 10, 2023

BacLuc commented Jan 2, 2024

DeNic0la commented Jan 6, 2024


		<em lang="de">Die <a href="#deutsch">deutsche Übersetzung</a> findest du weiter unten.</em>
		# English :milky_way:

		Following it will not only enhance the quality and consistency of your contributions:sparkles: but also fast-track the review process. :rocket:


		- [x] Sync with Central Repository: :arrows_counterclockwise: Ensure your fork is up to date with the central repository, facilitating a smooth merge.

	To begin with, utilize the `test@example.com / test` user credentials.
	To start out, utilize the `test@example.com / test` user credentials.

Updating information for Contributors #3874

Updating information for Contributors #3874

Conversation

DeNic0la commented Sep 30, 2023 • edited Loading

manuelmeister left a comment

Choose a reason for hiding this comment

carlobeltrame left a comment

Choose a reason for hiding this comment

manuelmeister left a comment

Choose a reason for hiding this comment

DeNic0la commented Oct 21, 2023 • edited Loading

I added a Database and Discussion chapter.

I added Emojis

In the Workflow chapter I added suggestions, did the spellcheck and made the following modifications:

I split the file into CONTRIBUTING.md and CONTRIBUTING_DE.md and here are my reasons:

🏁 IMO the English version is complete for the moment (meaning ready to be merged).

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

carlobeltrame left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

BacLuc commented Jan 2, 2024

DeNic0la commented Jan 6, 2024

DeNic0la commented Sep 30, 2023 •

edited

Loading

DeNic0la commented Oct 21, 2023 •

edited

Loading

I added a `Database` and `Discussion` chapter.

In the `Workflow` chapter I added suggestions, did the spellcheck and made the following modifications:

I split the file into `CONTRIBUTING.md` and `CONTRIBUTING_DE.md` and here are my reasons:

🏁 IMO the English version is complete for the moment _{(meaning ready to be merged).}