dx: add CONTRIBUTING.md file

[jideabdqudus]

Closes #71

• Created and wrote the Contributing Doc to assist with developers experience.

[vercel[bot]]

Someone is attempting to deploy a commit to a Personal Account owned by @ykdojo on Vercel.

@ykdojo first needs to authorize it.

[jideabdqudus]

This is a good start, but it's a lot to review in one go.

Any chance you could break it down to much smaller pieces and send individual PRs for them?

Do I close this PR and send new PRs as individual chunks? Or how do I go about this

[rohitdasu]

This is a good start, but it's a lot to review in one go. Any chance you could break it down to much smaller pieces and send individual PRs for them?

Do I close this PR and send new PRs as individual chunks? Or how do I go about this

Hi @jideabdqudus you don't need to close this PR. Update the PR whichever changes requested by @ykdojo

[subhoghoshX]

LGTM. Make the changes that YK mentioned and make sure to run it through a grammar checker like Grammarly or Quillbot.

[jideabdqudus]

LGTM. Make the changes that YK mentioned and make sure to run it through a grammar checker like Grammarly or Quillbot.

Changes have been made & I did the spell check as well cc @rohitdasu @ykdojo

[ykdojo]

^Once you address the comments I added above, I think it looks good to me.

I'll wait for one or two more reviewers to check it, though.

[iShibi]

You should move the content inside https://github.com/ykdojo/defaang#how-to-contribute into this file and then link this file under that sub-heading.

Also, write a note for the contributors to checkout a feature branch before working on a PR instead of adding changes in the main branch directly.

[jideabdqudus]

You should move the content inside https://github.com/ykdojo/defaang#how-to-contribute into this file and then link this file under that sub-heading.

Also, write a note for the contributors to checkout a feature branch before working on a PR instead of adding changes in the main branch directly.

Can you give more context to what you mean here?

[veganaize]

You should move the content inside https://github.com/ykdojo/defaang#how-to-contribute into this file and then link this file under that sub-heading. Also, write a note for the contributors to checkout a feature branch before working on a PR instead of adding changes in the main branch directly.

Can you give more context to what you mean here?

@jideabdqudus I think they mean you should move the contributing related stuff, from README.md, into CONTRIBUTING.md.

For their second request, about creating a new feature branch for each PR, you might reference the following document: https://github.com/LibreSprite/LibreSprite/blob/master/CONTRIBUTING.md#making-changes

[jideabdqudus]

You should move the content inside https://github.com/ykdojo/defaang#how-to-contribute into this file and then link this file under that sub-heading. Also, write a note for the contributors to checkout a feature branch before working on a PR instead of adding changes in the main branch directly.

Can you give more context to what you mean here?

@jideabdqudus I think they mean you should move the contributing related stuff, from README.md, into CONTRIBUTING.md.

For their second request, about creating a new feature branch for each PR, you might reference the following document: https://github.com/LibreSprite/LibreSprite/blob/master/CONTRIBUTING.md#making-changes

I got this,

For the first request, stuff from README.md are already in here. Then I added content explaining the steps in making changes.

[veganaize]

You should move the content inside https://github.com/ykdojo/defaang#how-to-contribute into this file and then link this file under that sub-heading.

For the first request, stuff from README.md are already in here. Then I added content explaining the steps in making changes.

@jideabdqudus Can you remove the entire "How to contribute" section from README.md and place it inside of CONTRIBUTING.md, link to CONTRIBUTING.md from README.md, and push that?

[jideabdqudus]

You should move the content inside https://github.com/ykdojo/defaang#how-to-contribute into this file and then link this file under that sub-heading.

For the first request, stuff from README.md are already in here. Then I added content explaining the steps in making changes.

@jideabdqudus Can you remove the entire "How to contribute" section from README.md ~and place it inside of CONTRIBUTING.md~, link to CONTRIBUTING.md from README.md, and push that?

Okay that makes sense, I just did with the new push

[veganaize]

@jideabdqudus Can you remove the entire "How to contribute" section from README.md ~and place it inside of CONTRIBUTING.md~, link to CONTRIBUTING.md from README.md, and push that?

Okay that makes sense, I just did with the new push

I could be wrong but it looks like you've removed the "How to contribute" section from CONTRIBUTING.md and not from README.md? It should be the other way around. [Sorry if my crossed out comment confused you.]

[jideabdqudus]

@jideabdqudus Can you remove the entire "How to contribute" section from README.md ~and place it inside of CONTRIBUTING.md~, link to CONTRIBUTING.md from README.md, and push that?

Okay that makes sense, I just did with the new push

I could be wrong but it looks like you've removed the "How to contribute" section from CONTRIBUTING.md and not from README.md? It should be the other way around. [Sorry if my crossed out comment confused you.]

Oh Dang, you lost me a bit. I've reverted this and fixed README.md

[veganaize]

Oh Dang, you lost me a bit. I've reverted this and fixed README.md

Sorry... my bad @jideabdqudus !

This all looks good, to me. What do you think @ykdojo , @rohitdasu , and @iShibi ?

[rohitdasu]

Can you add a link to CONTRIBUTING.md from README.md?

yes agree, should have a link to CONTRIBUTING.md

[jideabdqudus]

Okay guys, back to this :). I've added a link to CONTRIBUTING.md from README.md with the latest push. Can we once go through the file so I wouldn't have to make little changes again @ykdojo @rohitdasu @iShibi

[ykdojo]

Thank you so much! Looks good to me.

[iShibi]

@jideabdqudus looks good. Resolve the git conflicts by rebasing and then we will merge it.

[vercel[bot]]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Updated
defaang	✅ Ready (Inspect)	Visit Preview	Aug 22, 2022 at 10:26AM (UTC)

[jideabdqudus]

@jideabdqudus looks good. Resolve the git conflicts by rebasing and then we will merge it.

Feel free to merge now

[iShibi]

You overwrote the changes made in the main. I'll have to rebase it and then we can merge.