Skip to content

spacetelescope/style-guides

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Style Guides

This repository contains styles guides, suggested workflows, and best practices for sofware-related content developed by STScI staff. Style guides are designed to ensure that STScI software, GitHub repositories, documentation, and example analyses follow a consistent style. Suggested workflows provide robust methods for producing work to help aid collaboration and maximize clarity. While we recommend reading the full policies and further material, we highlight some of the most common best practices that are applicable to our software projects.

Currently there are styles guides for:

In addition, there are the following guides for best practices and workflows:

Related work

Contributing

If you want to suggest changes to this content do the following:

  1. Fork it.
  2. Create your feature branch (git checkout -b my-new-feature).
  3. Add your changes to staging area (git add myfile); This can be repeated multiple times.
  4. If you are adding a new style guide, do not forget to update guides listing at README.md.
  5. Commit your changes in staging area (git commit -m 'Added some feature').
  6. Push to the branch (git push origin my-new-feature).
  7. Create new Pull Request (PR).
  8. Ask for a PR review.

About

An opinionated guide on how we work.

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published