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

Add Contributing Guidelines #38

Merged
merged 13 commits into from
Jan 24, 2024
Merged

Add Contributing Guidelines #38

merged 13 commits into from
Jan 24, 2024

Conversation

phoenixpereira
Copy link
Member

Description

Added a basic contributing guidelines and updated the README file.

Changes Made

  • Customised the README file to suit our repo.
  • Added contributing guidelines with instructions for reporting issues and contributing changes.

Related Issues

N/A

Additional Notes

Contributing guidelines are useful for new people who want to contribute to the project.

README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Show resolved Hide resolved
@phoenixpereira
Copy link
Member Author

Do we want to add a license to the project?

@rayokamoto
Copy link
Contributor

We should probably add a license, yes. What licenses are you thinking of?

Some common licenses:
https://choosealicense.com/

@jsun969
Copy link
Member

jsun969 commented Jan 24, 2024

AGPL v3 or MIT ?

@phoenixpereira
Copy link
Member Author

Probably MIT

@rayokamoto
Copy link
Contributor

Happy to go with MIT

LICENSE Outdated Show resolved Hide resolved
Co-authored-by: Yeyang (Justin) Sun <[email protected]>
README.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Show resolved Hide resolved
@rayokamoto rayokamoto self-requested a review January 24, 2024 04:26
Copy link
Member

@jsun969 jsun969 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@rayokamoto rayokamoto merged commit ebd4d02 into main Jan 24, 2024
2 checks passed
@rayokamoto rayokamoto deleted the documentation branch January 24, 2024 06:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

3 participants