Skip to content

Latest commit

 

History

History
109 lines (70 loc) · 6.33 KB

Contributors.md

File metadata and controls

109 lines (70 loc) · 6.33 KB

Contributing to Data Curation Primers


When contributing to this repository, please first discuss the change you wish to make by creating an issue, email, or other communications with the owners of this repository before making a change. Please follow our code of conduct in all your interactions with the project.

Pull Request Process

The process described here has several goals:

  • Maintain Data Curation Primer’s quality
  • Fix problems that are important to users
  • Engage the community in working toward the best possible Data Curation Primers
  • Enable a sustainable system for Data Curation Primer's maintainers to review contributions

Please use the attached templates (contributor.md, readme.md) at the end of this document to have your contribution considered by the maintainers:

  1. Create/Update a README.md with details of changes to the interface, such as line numbers of code modifications, purpose of modifications and references.
  2. Increase the version numbers in any examples files and the README.md to the new version that this Pull Request would represent. The versioning scheme we use is SemVer. For example, this is how we adapt SemVer for this guide: given a version number MAJOR.MINOR, increment the:
  • MAJOR version when you make major changes, such as adding new content,
  • MINOR version when you make small changes, such as fix formatting issues.
  1. You may merge the Pull Request in once you get permission from the reviewer or if you do not have permission to do that, you may request the reviewer to merge it for you.
  2. Suggested process for making pull requests from people who are in the DCN: checkout a local branch, make edits, push it upstream, and then request a review.

Code of Conduct


Our Pledge

In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.

Our Standards

Examples of behavior that contributes to creating a positive environment include:

  • Using welcoming and inclusive language
  • Being respectful of differing viewpoints and experiences
  • Gracefully accepting constructive criticism
  • Focusing on what is best for the community
  • Showing empathy towards other community members

Examples of unacceptable behavior by participants include:

  • The use of sexualized language or imagery and unwelcome sexual attention or advances
  • Trolling, insulting/derogatory comments, and personal or political attacks
  • Public or private harassment
  • Publishing others' private information, such as a physical or electronic address, without explicit permission
  • Other conduct which could reasonably be considered inappropriate in a professional setting

Our Responsibilities

Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior. Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.

Scope

This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.

Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [email protected]. All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately. Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.

Attribution

This Code of Conduct is adapted from The Contributor Covenant, version 1.4, available at http://contributor-covenant.org/version/1/4 The contribution template and pull requests process is adapted from The Atom contribution guidelines, available at https://github.com/atom/atom/blob/master/CONTRIBUTING.md

Contribution template for each primer starts below line


Requirements for Contributing Documentation

  • Fill out the template below. Any pull request that does not include enough information to be reviewed in a timely manner may be closed at the maintainers' discretion.

Description of the Change

We must be able to understand the purpose of your change from this description. If we can't get a good idea of the benefits of the change from the description here, the pull request may be closed at the maintainers' discretion.

Release Notes

Please describe the changes in a single line that explains this fixation or improvement in terms that a user can understand.

Additional Fields

Other fields may be added to describe events or working groups that have been approved or are organized by the Data Curation Network. These additional fields may include a place to list a description of the event or members of a working group.

Readme.md template for each primer starts below line


Current Version:

License:

CC by 4.0

Citation:

Citation here

Funding:

This primer was developed as part of the IMLS grant #RE-85-18-0040-18 "Building the Data Curation Community: Advancing Specialized Data Curation".


Please update the following fields with each contribution

Version:

Summary of changes:

Date [mm/dd/yyyy]

Note: please add change date in descending order