search

tact-lang / tact

Tact compiler main repository
https://tact-lang.org
MIT License
390 stars 106 forks source link

Contributing guide is missing #186

Closed anton-trunov closed 1 month ago

anton-trunov commented 7 months ago

In addition to #130, we should have a contributing guide explaining the workflow for working on Tact contributions from the community.

For instance, we should mention in the guide that PRs should have opened and discussed issues before working on them. And also, a PR should be focused on one issue it is trying to resolve. Carpet PRs targeting multiple non-related issues are discouraged. Btw, we as a team should adhere to this policy too, to set an example.

byakuren-hijiri commented 7 months ago

Another idea would be to add the .github/pull_request_template.md file.

We could specify a short checklist for contributors, for example:

Closes #<issue number>

* [ ] I have updated CHANGELOG.md
* [ ] I have added unit tests to check possible regressions
spartan124 commented 7 months ago

This would be nice to have. Also contributors can attach video or loom link to PRs to showcase changes made so reviewers can easily check and merge

novusnota commented 7 months ago

This page from Gleam project may suit as a good starting point for describing the compiler structure (ARCHITECTURE.md, perhaps?): https://github.com/gleam-lang/gleam/tree/main/docs/compiler

UPD: Nice post on the topic, https://matklad.github.io/2021/02/06/ARCHITECTURE.md.html

anton-trunov commented 7 months ago

Looks great, indeed! Thanks @novusnota

novusnota commented 5 months ago

https://github.com/nayafia/contributing-template — found an awesome template to start off of.

Additionally, we should introduce a couple of templates for new issues — bug report, feature suggestion/proposal, etc.

Gusarich commented 1 month ago

@anton-trunov this one is already completed and should be closed, right?