NASA-AMMOS / NASA-AMMOS/slim

[New Best Practice Guide]: Integrate Expectations and Acknowledgements for Open Science

Open
#173 19 comments 0 reactions 1 assignee View on GitHub

@yunks128 is already working on this.

Since Oct 1, 2024.

governance high complexity most requested
Dominant language
JavaScript
Stars
36
Forks
14
PR merge metrics
No merged PRs in 30d

Description

Checked for duplicates

Yes - I've already checked

Describe the needs

Following the recent discussions (@c-h-david @PaulMRamirez @hookhua @yunks128)about the potential creation of an EXPECTATIONS.md file, it has been suggested that we could consider incorporating these elements into a more approachable ACKNOWLEDGMENTS.md file (@PaulMRamirez). This file could serve a dual purpose:

  1. Acknowledgments: Recognize contributions, support, and resources.
  2. Commitment to Open Science: Define the project's commitment to open science principles, outlining expectations for contributions, collaboration, and scientific impact.

Proposed Structure for ACKNOWLEDGMENTS.md:

  • Contributors:

    • Core Team
    • External Contributors
  • Special Thanks:

    • Individuals or organizations that provided guidance, inspiration, or support.
  • Code Attribution:

    • Citing external libraries, frameworks, or code snippets.
  • Funding and Support:

    • Acknowledgment of financial support or grants.
  • Documentation and Community:

    • Recognition of contributions to documentation, translations, or community support.
  • Commitment to Open Science:

    • Outline the project's commitment to open science.
    • Describe expectations related to scientific integrity, publication contributions, and funding support.

Discussion Points:

  • Should we integrate expectations into the ACKNOWLEDGMENTS.md, or should they be a part of a separate EXPECTATIONS.md file?
  • What are the specific commitments to open science that should be included?
  • How can we ensure that this file is comprehensive but remains approachable and clear for all contributors?

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.