Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Doc: Contributing #45

Draft
wants to merge 17 commits into
base: main
Choose a base branch
from
Draft

Conversation

hanihusam
Copy link
Contributor

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
Copy link
Contributor Author

hanihusam commented Jul 15, 2024

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
Copy link
Contributor

mhaidarhanif commented Jul 15, 2024

@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
Copy link
Contributor

@zainfathoni will help on the recommendation

@zainfathoni
Copy link
Member

@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
Copy link
Contributor Author

@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 🫡

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

CONTRIBUTING.md for "how to contribute" flow
3 participants