From 732d83214ce4a2146362660a419ec3147198e7aa Mon Sep 17 00:00:00 2001 From: Jackson Hoffart Date: Fri, 10 Jul 2026 15:46:02 +0200 Subject: [PATCH] gains profile/README.md --- profile/README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) create mode 100644 profile/README.md diff --git a/profile/README.md b/profile/README.md new file mode 100644 index 0000000..c4f0423 --- /dev/null +++ b/profile/README.md @@ -0,0 +1,12 @@ +## Using RMI's GitHub organization + +- Do, in fact, **use it!** Code written for RMI should be in a git repo and committed to the RMI GitHub account, not personal or unofficial RMI accounts. + +- **Be safe**. Make sure your repo has a [.gitignore file](https://docs.github.com/en/get-started/git-basics/ignoring-files) and that you don't commit keys or anything else that shouldn't be saved or shared. Use [.env](https://www.dotenv.org/docs/security/env) as a safe way to manage secrets and avoid committing them. + +- Give your repo an **informative READE.md**. "Code for project" is not great. A short description of what it does and how to use it is a good start. Check the [GitHub docs](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-readmes) for more. + +- **Adopt better GitHub practices**. Start by [improving your commits](https://gist.github.com/luismts/495d982e8c5b1a0ced4a57cf3d93cf60). Check out SPD's [practices repo](https://github.com/rmi/practices) for more. + +RMI's GitHub is supported by [SPD](https://rockmtnins.sharepoint.com/sites/ClimateIntelligence/SitePages/SPD.aspx), RMI's Software, Product, and Data team. [Reach out to us](mailto:spd@rmi.org) if we can help. +