Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
76 lines (47 loc) · 3.83 KB

CONTRIBUTING.md

File metadata and controls

76 lines (47 loc) · 3.83 KB

Contributing

First off, thank you for considering contributing to this list. The scientific ballooning community is a relatively small one, and contributions from people like you make being a part of it rewarding.

If you're new to open source, you can learn more about open source projects here.

To make this resource as useful as possible and keep it easy to maintain, we set forth these contribution guidelines for list items.

Format

To keep the list organized and readable.

Project Name: A one sentence description of the item.

The markdown for this looks like:

[**Project Name**](https://example.com): A one sentence description of the item.

Scope

To keep the content relevant and avoid becoming a dumping ground for ideas.

  • Solves a particular problem
    • Think "Instructables," rather than a mission concept, system description, or trade study
    • e.g., printed circuit board layout files + bill of materials + assembly instructions for a modular power breakout system
  • Is a well-defined project, process, or subsystem
    • Is not just a paper on the topic
      • Papers provide context and are a great formal record of work done and its novelty, but are not the format with the least friction for reuse.
    • Projects can and should link publications and memos for context and impact!

Prerequisites

To ensure the quality and usability of the list items.

  • Complete
    • Project or process has been flown or lab tested for a balloon that is being developed
  • Licensed
    • Open source licenses encourage reuse and community contribution. Especially for code products, having a license is critical for allowing reuse. GitHub has some information on selecting licenses (open source or not) here
  • Documented
    • Tell the reader what they need to know to get started, and maybe link to additional resources
    • e.g., don't link to a repository that has a blank README.md or doesn't list software dependencies
  • Terms for reuse and acknowledgment
    • Specify who should be cited in publications and how (e.g. BibTeX snippets, example citations), if applicable
    • Provide acknowledgments of support from institutions, if applicable

CAUTION: As a guideline, only add items you're involved in, or after asking the maintainer(s). This list may provide a signal boost, and it's best that maintainers know this and are ready for the increased attention.

Add items!

Do you have something you're proud of that you think others can benefit from?

You can add items to the list via the pull request system. In this model, you are asking the maintainers to incorporate the changes you have made on your own.

Suggest removals!

Do you see an item that you think doesn't belong?

Create an issue for discussion.

Talk to others!

When an aspect of a project linked here becomes obsolete or out-of-date, notify the maintainers of that project.

If you find an item useful and iterate on it, provide your changes as feedback to the maintainers of that project to help improve it!

Conduct

Use issue templates when creating issues.

Use pull request templates when creating pull requests.

We have adopted a code of conduct from a GitHub template, which we may modify in the future.

Frequently Asked Questions