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.

Sign up for GitHub

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

Jump to bottom

Add contributing guidelines #251

Merged
merged 5 commits into from
Oct 2, 2024
Merged

Add contributing guidelines #251

merged 5 commits into from
Oct 2, 2024

Conversation

SimonNyvall
Copy link
Contributor

Added contributing guidelines that cover:

  • Git branching
  • Git commit messages
  • Getting started (e.g., forking)
  • Building the project (including notes on differences)
  • Issue reporting
  • Link to license
  • Contact information (Discord server and GitHub issues)
  • File naming conventions

Sources include examples found in the git history and commit messages.

Changes made:

  • Added CONTRIBUTING.md to the repository.
  • Updated README.md to include build steps from CONTRIBUTING.md.

@SimonNyvall
Copy link
Contributor Author

That should resolve all the spacing issues. It's frustrating when the Markdown preview in VS Code doesn't match how GitHub renders Markdown.

@tareqimbasher tareqimbasher merged commit b575bd9 into tareqimbasher:main Oct 2, 2024
9 checks passed
@tareqimbasher
Copy link
Owner

Thank you @SimonNyvall!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@SimonNyvall @tareqimbasher