Skip to content

Latest commit

 

History

History
73 lines (48 loc) · 4.58 KB

README.md

File metadata and controls

73 lines (48 loc) · 4.58 KB
Raw

delegate-contributions-dp01

This repository is for DP0 delegates to contribute and share DP0.1-related materials (e.g., code, analysis tools, tutorials).

Tutorials could be Jupyter Notebooks, or markdown-formatted demonstrations of a DP0.1-related analysis with command-line tasks or the Portal Aspect.

Please contribute only code that you have verified to run.

How to contribute to this repository.

Workflow

  1. Make a branch for your work, and name it u/(your github username).
  2. Add and edit content in your branch until you're ready to share it with everyone.
  3. Start a new Pull Request (PR) from your branch to main.
  4. Request a review from another delegate or Rubin staff (safety feature; see below).
  5. Merge your branch into main.

Do not commit changes directly to main.

Reviews

For this repository, all PRs to merge to the main branch must be reviewed. Reviewers should confirm that the PR is adding or editing only the user's own files in their own folder. Reviewers should not evaluate the additions or changes: this is not a code review nor a peer review. These reviews are just a saftey feature to avoid, e.g., this README.md being accidentally deleted (which has happened). If the PR is deleting a file the reviewer should confirm that the user intended this deletion. Reviewers can provide comments and approve the PR, but should not edit files, merge, or close the PR.

Any delegate who is unsure about how to request a review for a PR, or needs a reviewer, can ask Melissa Graham.

Directories

All materials should be organized into directories. An example directory is provided as an illustration. Anyone may make a directory for a specific science topic, a specific tool or type of analysis, by DP0.1 working group, etc. Directory creators should create a README.md file within the directory that identifies them as the directory maintainer and describes the contents of the directory. Contact the directory creator if you want to contribute content to their directory. Direct messages between delegates in Community.lsst.org is an appropriate mode of contact.

Best Practices

Please always:

  • document your code for non-experts
  • provide links to background information
  • clear notebook outputs before committing changes

All tutorials should have a header containing:

  • the author's name
  • the date the tutorial was last tested
  • the goals of the notebook

See the example directory for guidance on formatting notebooks and markdown files.

Need to learn how to use GitHub?

Git is already installed in the Notebook Aspect of the Rubin Science Platform.

The best place to start in the extensive GitHub documentation is with the quickstart setup guide. There is also a GitHub Cheat Sheet of commonly used commands, and a GitHub Glossary.

Git Tutorial for Beginners: Command-Line Fundamentals (a YouTube tutorial that includes git command line basics, but if you are not installing Git, you might want to skip a section of it describing the installation).

What college students should learn about Git (a medium.com article that includes fundamental git concepts and basic git commands).

Phil Marshall's notes on "Getting Started with git and GitHub".

Generating a new SSH key and adding it to the ssh-agent, a guide to setting up git credentials so that you can push changes back to your remote repositories.

See also the GitHub Cheat Sheet provided in this repository. This cheat sheet was developed by Douglas Tucker for the LSST Science Collaborations Stack Club and altered to be appropriate for Data Preview 0 by Greg Madejski.

Too many notifications?

How to unsubscribe / unwatch GitHub repositories.