search

reactjs-id / website-remix

ReactJS Indonesia Website with Remix
https://remix.reactjs.id
14 stars 13 forks source link

Doc: Contributing #45

Open hanihusam opened 1 month ago

hanihusam commented 1 month ago

Closes #24

Description

A documentation about "How to Contribute" in the project

Related Issues (optional)

(Only for Bug fix PR)

Screenshot / Screen Recording

Before This PR

(A screenshot/video before this PR is made)

After This PR

(A screenshot/video after this PR is made)

How Has This Been Tested (optional)

(Describe concisely how the test is done)

hanihusam commented 1 month ago

Hi @mhaidarhanif, we have different pull request formats from WBW's. It's related to the Contributing Doc.

WBW's

Should I change ours to follow WBW's or we keep ours as it is?

mhaidarhanif commented 1 month ago

@hanihusam We can keep ours as simple as possible

Think how it can be read and understood in less than a minute

WBW is for inspiration only

Another important thing is to write the CONTRIBUTING file in 100% English

mhaidarhanif commented 1 month ago

@zainfathoni will help on the recommendation

zainfathoni commented 1 month ago

@hanihusam We can keep ours as simple as possible

Think how it can be read and understood in less than a minute

WBW is for inspiration only

Agreed. I realised that WBW format is trying to explain too many concepts in a single document. We can make them brief and understandable in a minute by removing details and probably splitting them into separate files as a further reference.

Another important thing is to write the CONTRIBUTING file in 100% English

Yes, consistency in the language usage will be beneficial in the long run.

hanihusam commented 1 month ago

@hanihusam We can keep ours as simple as possible

Think how it can be read and understood in less than a minute

WBW is for inspiration only

Agreed. I realised that WBW format is trying to explain too many concepts in a single document. We can make them brief and understandable in a minute by removing details and probably splitting them into separate files as a further reference.

Another important thing is to write the CONTRIBUTING file in 100% English

Yes, consistency in the language usage will be beneficial in the long run.

Ay ay, captain 🫡