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.md file #681

Closed

Conversation

amitkumar-y
Copy link

Add the Contributing.md file to the repository.

Resolves: #678

What's Changed:

New details for starting the contribution to this project have been added in the Contributing.md file. It will assist those who wish to contribute.

Type of Change:

  • Bug fix
  • [x ] New feature
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)

Housekeeping:

  • Tests have been updated to reflect the changes done within this PR (if applicable).
  • Documentation has been updated to reflect the changes done within this PR (if applicable).

Screenshots (If Applicable):

@amitkumar-y amitkumar-y mentioned this pull request Oct 20, 2023
1 task
@Jason2605
Copy link
Member

Thanks for this but we potentially need to think about what to put in this file. I feel like making it a guide on how to make a PR probably isn't what we want, and instead we want something maybe a little more in-depth on how to contribute to the source.

I think things like how to modules work in the VM, how we can add more native functions, how we can add functions to types etc are all things that are definitely worth documenting somewhere (maybe a wiki?) then that can be referenced in this file.

For your effort i'll stick a hacktoberfest accepted on it, sorry probably should have went through it more on the issue

@briandowns
Copy link
Contributor

I agree with the synopsis above. The contributors doc should be the guide anyone can use to update tests, docs, modules, etc.

@Jason2605 Jason2605 closed this Nov 2, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Contributing md file
3 participants