From b91356bd63adbc8a1ea236f557e39d121a780612 Mon Sep 17 00:00:00 2001 From: Marco Buono Date: Wed, 30 Nov 2022 02:44:05 +0000 Subject: [PATCH] =?UTF-8?q?Add=20note=20about=20global=20`.gitignore`=20to?= =?UTF-8?q?=20`CONTRIBUTING.md`=20=E2=80=94=20Instead=20of=20ignoring=20`.?= =?UTF-8?q?DS=5FStore`=20files=20created=20by=20macOS=20Finder=20(#6499)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit # Objective Finder in macOS creates hidden `.DS_Store` files containing metadata (for icon positioning, view mode, etc) whenever you browse a directory. There's no point in committing these to git, and they're a common git + macOS nuisance. ## Solution - ~~This PR adds `.DS_Store` files to `.gitignore`, improving the developer experience on macOS.~~ - This PR adds a note to the `CONTRIBUTING.md` file teaching how to use global git ignore. --- CONTRIBUTING.md | 1 + 1 file changed, 1 insertion(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 586513eb99..92adc7ddfe 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -282,6 +282,7 @@ If you're new to Bevy, here's the workflow we use: 1. Fork the `bevyengine/bevy` repository on GitHub. You'll need to create a GitHub account if you don't have one already. 2. Make your changes in a local clone of your fork, typically in its own new branch. 1. Try to split your work into separate commits, each with a distinct purpose. Be particularly mindful of this when responding to reviews so it's easy to see what's changed. + 2. Tip: [You can set up a global `.gitignore` file](https://docs.github.com/en/get-started/getting-started-with-git/ignoring-files#configuring-ignored-files-for-all-repositories-on-your-computer) to exclude your operating system/text editor's special/temporary files. (e.g. `.DS_Store`, `thumbs.db`, `*~`, `*.swp` or `*.swo`) This allows us to keep the `.gitignore` file in the repo uncluttered. 3. To test CI validations locally, run the `cargo run -p ci` command. This will run most checks that happen in CI, but can take some time. You can also run sub-commands to iterate faster depending on what you're contributing: * `cargo run -p ci -- lints` - to run formatting and clippy * `cargo run -p ci -- test` - to run tests