deta / space-docs

Documentation and guides for Deta Space
https://deta.space/docs
Other
42 stars 15 forks source link

Contribution guidelines; moved .vscode/settings.json to settings.json.example; added extensions.json #172

Open peter-lyons-kehl opened 1 year ago

peter-lyons-kehl commented 1 year ago

I also have a list of VS Code extensions for Rust development, and general code navigation, that is not documentation/Markdown-specific. Please ping me if you know of a better repo/file to share it.

abdelhai commented 1 year ago

hi Peter, thanks for the PR! could you please explain more what the PR tries to achieve and the what the extensions do in detail? also I'm not sure why we should have Rust specific language & extensions in this repo.

peter-lyons-kehl commented 1 year ago

While on the theme of source code contributions: I'm surprised that Deta uses GIT merging. It adds extra commits to the history. But much worse, if I remember right, it puts the burden of adjusting/fixing conflicts on the person doing the maintenance/merging.

Many large open source projects or companies use rebase instead. That moves the responsibility of solving the conflicts and updating ("rebasing") the PR branch to be up-to-date with main (or wherever it's being rebased on) to the contributor. If a PR is accepted, there is no extra merging commit, and the history is exactly the same on both branches. image

It does mean more work for the contributors, and a little bit of learning. They love learning. And that amount of work has to be done by someone anyway. If they're motivated to get their PR accepted, they'll do so - and save Deta team's time.