https://github.com/spacetelescope/style-guides

An opinionated guide on how we work.
https://github.com/spacetelescope/style-guides

Last synced: about 1 month ago
JSON representation

An opinionated guide on how we work.

• Host: GitHub
• URL: https://github.com/spacetelescope/style-guides
• Owner: spacetelescope
• License: cc-by-4.0
• Created: 2018-05-05T00:42:14.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2023-01-25T19:01:32.000Z (almost 2 years ago)
• Last Synced: 2024-11-22T02:00:16.009Z (about 2 months ago)
• Language: Jupyter Notebook
• Homepage:
• Size: 667 KB
• Stars: 55
• Watchers: 113
• Forks: 33
• Open Issues: 28
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md
  • Codeowners: CODEOWNERS

Awesome Lists containing this project

README

        
# 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:

- [GitHub repositories](guides/github-repositories.md)

- [Jupyter Notebooks](guides/jupyter-notebooks.md)

- [Python](guides/python.md)

- [Accessibility](guides/accessibility.md)

- [Security](guides/security.md)

- [Web Pages](guides/web-styles.md)

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

- [Git Workflow](guides/git-workflow.md)

- [PR Review](guides/git-pr-review.md)

- [Software Versioning](guides/software-versioning.md)

- [Python Packaging](guides/python-package.md)

- [Testing Python Packages](guides/python-testing.md)

- [Storing Data](guides/where-to-put-your-data.md)

- [Release Workflow](guides/release-workflow.md)

### Related work

- The STScI package template: https://github.com/spacetelescope/stsci-package-template

## 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.