search

callahantiff / PheKnowLator

PheKnowLator: Heterogeneous Biomedical Knowledge Graphs and Benchmarks Constructed Under Alternative Semantic Models
https://github.com/callahantiff/PheKnowLator/wiki
Apache License 2.0
166 stars 29 forks source link

TODO - Project Organization: add contributing information #8

Closed callahantiff closed 5 years ago

callahantiff commented 5 years ago

Task: Add documentation for contributing

Description: Create or modify contribution information for project. A good example of how to do this can be seen here.

Here is a general outline:

Contributing to the PheKnowLater Project

:tada: :clap: First off, thanks so much for being willing to contribute to our project! :thumbsup: :bowtie:

We welcome contributions to our project and ask that you please follow the Code of Conduct.

We Support Reproducible Research

Please also take a look at how we use GitHub to enable reproducible research. We are also working on creating guidelines we would like our project collaborators to follow. Please take a look, if you have suggestions we'd love to hear them here.

Contributing

Issues

When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change. Whenever possible, the issue templates should be selected according to their description:

  • Bug report: A built-in issue template that should be used when you find an issue in the code base that needs to be fixed.
  • Coding Tasks: A custom template that should be used when you want to request a change be made to existing code or when you want to suggest new code that could be added to the code base.
  • Feature request: A built-in issue template that is used when you have a new idea or suggestion that you would like to share with the project developers.
  • Help: A custom template that should be used when you have a question on how to contribute to the repository. This can also be used a place for asking any question on how to contribute to this repository.
  • Manuscript Tasks: A custom template that should be used when you want to create a task that is related to a manuscript being written about/using this project.
  • Meetings: A custom template that should be used when you want follow-up on a task assigned during a meeting or when you want to suggest a new topic for discussion at an upcoming meeting.
  • Other: A custom template that should be used when you are unable to use any of the other issue templates (e.g. general questions about
  • Project Organization Tasks: A custom template that should be used when you want to add a task related to the organization of the project (e.g. adding collaborators or modifying project boards or milestones).
  • Wiki: A custom template that should be used when you want to suggest and edit to the project Wiki page.

Once you have selected the type of issue you want to submit, you will be presented with an empty template, specific to that issue, and asked to provide certain information.

Pull Requests

In general, we follow the "fork-and-pull" Git workflow.

  1. Fork the repo on GitHub
  2. Clone the project to your own machine
  3. Commit changes to your own branch
  4. Push your work back up to your fork
  5. Submit a Pull request to our development branch so that we can review and add your changes

NOTE: Be sure to merge the latest from "development" before making a pull request!

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 here. 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 document was inspired by atom's CONTRIBUTION documentation

This Code of Conduct is adapted from the Contributor Covenant, version 1.4, available at http://contributor-covenant.org/version/1/4

callahantiff commented 5 years ago

UPDATE: File has been added here