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

docs: improved CONTRIBUTING.md and added Code of Conduct #39

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

azriel-stephen
Copy link

@azriel-stephen azriel-stephen commented Oct 10, 2023

What does this PR do?

This PR fixes some issues with CONTRIBUTING.md mentioned below:

  1. Table of Contents was written incorrectly.
  2. Dev env setup code snippet was incorrect.
  3. Edited .env Configuration to make it more concise and clear
  4. Frontend Reference Link has been added.
  5. Code of Conduct section has been fixed with the correct file and reference.

Fixes #11

Loom Video (Please watch at 1.2x or 1.5x speed) : Video

Type of change

  • This change requires a documentation update

How should this be tested?

  • CONTRIBUTING.md file should be read to see the changes.

Mandatory Tasks

  • I have self-reviewed the code.

Checklist

  • All done

@github-actions github-actions bot added bug Something isn't working documentation Improvements or additions to documentation good first issue Good for newcomers hacktoberfest Hacktoberfest Accepted Issues labels Oct 10, 2023
@github-actions
Copy link

github-actions bot commented Oct 10, 2023

Thank you for following the naming conventions! 🙏

@azriel-stephen azriel-stephen marked this pull request as ready for review October 10, 2023 18:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working documentation Improvements or additions to documentation good first issue Good for newcomers hacktoberfest Hacktoberfest Accepted Issues
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Docs] Correct the Grammar of CONTRIBUTING.md
1 participant