Skip to content

Conversation

chlawrence31
Copy link
Contributor

I added the code of Code of Conduct and Contribution Guide using other repositories code of conducts and contribution guide as reference.

@amit9838
Copy link
Owner

amit9838 commented Feb 15, 2024

Hi @chlawrence31 thanks for your contribution.
Actually github provides some standards for this purpose.
So filename shoud be like -
CONTRIBUTING.md (root dir)
CODE_OF_CONDUCT.md (.github dir)
// We are not maintaining any docs so we can skip that.

In CONTRIBUTING.md file you also need to write basic instructions like

  • setting up the project (including fork)
  • Steps to build the project (Platform specific)
  • Submitting the Code or raising issue

https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/setting-guidelines-for-repository-contributors
https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/adding-a-code-of-conduct-to-your-project

@amit9838 amit9838 changed the title Added a Code of Conduct and Contribution Guide page Add Code of Conduct and Contribution Guide page Feb 15, 2024
@amit9838 amit9838 merged commit 24eda15 into amit9838:master Feb 24, 2024
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.

2 participants