Skip to content

gains profile/README.md #8

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
jdhoffa wants to merge 1 commit into
base: main
Choose a base branch
from
Open

gains profile/README.md #8

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions profile/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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:[email protected]) if we can help.