tact icon indicating copy to clipboard operation
tact copied to clipboard

Contributing guide is missing

Open anton-trunov opened this issue 11 months ago • 5 comments

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.

anton-trunov avatar Mar 23 '24 10:03 anton-trunov

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

byakuren-hijiri avatar Mar 27 '24 13:03 byakuren-hijiri

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

spartan124 avatar Mar 28 '24 19:03 spartan124

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

novusnota avatar Mar 30 '24 23:03 novusnota

Looks great, indeed! Thanks @novusnota

anton-trunov avatar Mar 31 '24 09:03 anton-trunov

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.

novusnota avatar May 16 '24 13:05 novusnota

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

Gusarich avatar Sep 19 '24 21:09 Gusarich