From f961dd4acd2876646e91660e95cdec6797e483eb Mon Sep 17 00:00:00 2001 From: jelveh Date: Thu, 11 Dec 2025 16:58:21 -0800 Subject: [PATCH] Update CONTRIBUTING.md --- CONTRIBUTING.md | 36 ------------------------------------ 1 file changed, 36 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 5789b8b73..71c12855d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -84,10 +84,6 @@ to review style PRs separately because we can use javascript parsers to verify t are no functional changes and then simply skim though the code and see if it "looks better". -## Repository Structure - -![file structure](./doc/File%20Structure.drawio.png) - ## Your first code contribution We maintain a list of issues that are good for first-time contributors. You can find these issues by searching for the [`good first issue`](https://github.com/HeyPuter/puter/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) label in our [GitHub repository](https://github.com/HeyPuter/puter). These issues are designed to be relatively easy to fix, and we're happy to help you get started. Pick an issue that interests you, and leave a comment on the issue to let us know you're working on it. @@ -108,38 +104,6 @@ We expect the following from pull requests (it makes things easier):
-## Commit Messages - -**Note:** we will squash-merge some PRs so they follow . Large PRs should follow conventional commits also. The instructions below are outdated but suitable for most PRs. - -### Conventional Commits -We use [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) with the following prefixes: -- `fix:` for bug fixes -- `dev:` instead of `refactor:`; covers more basis -- `tweak:` for small updates -- `sync:` when updating data from another source -- `feat:` for a commit that first introduces a new feature - -Commit messages after the prefix should use the imperative (the same convention used in the repo for Linux, which Git was built for): - -- correct: `dev: improve performance of readdir` -- incorrect: `dev: improved readdir` -- incorrect: `dev: improving readdir` - -We have the following exceptions to this rule: -- If the commit message is in _past tense_, it's a shorthand for the following: - - `dev: apply changes that would be applied after one had ` -- If the commit message is in _present tense_, it's shorthand for the following: - - `dev: apply changes that would be applied after ` - -For example, the following are correct: -- `dev: improved readdir` - - interpret this as: `dev: apply changes that would be applied after one had improved readdir` -- `dev: improving readdir` - - interpret this as: `dev: apply changes that would be applied after improving readdir` - -
- ## Code Review Once you've submitted your pull request, the project maintainers will review your changes. We may suggest some changes or improvements. This is a normal part of the process, and your contributions are greatly appreciated!