dictu-lang / Dictu

Dictu is a high-level dynamically typed, multi-paradigm, interpreted programming language.

https://dictu-lang.com

MIT License

268 stars 53 forks source link

Add Contributing.md file #681

Closed amitkumar-y closed 10 months ago

amitkumar-y commented 11 months ago

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):

Jason2605 commented 11 months ago

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 commented 11 months ago

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