Skip to content

Latest commit

 

History

History
124 lines (95 loc) · 4.85 KB

Contributing.md

File metadata and controls

124 lines (95 loc) · 4.85 KB
Raw

Contributing to AVIAN-MAMM

August, 2023

A big welcome and thank you for considering contributing to AVIAN-MAMM! We want to make contributing to this project as easy and transparent as possible, whether it is:

  • Suggesting changes to the dataset
  • Suggesting changes to the code
  • Submitting new data
  • Contributing to the code

The AVIAN-MAMM project uses GitHub to host data and code, receive new data submission, track issues, and pull requests. Contributions are made to this repository via Issues and Pull Requests.

Please take a moment to review this document in order to make the contribution process easy and effective for everyone involved.

Using the Issue tracker

The Issue tracker is the preferred channel for suggesting changes to the data or to the code (e.g. reporting errors) and for submitting new avian flu events to the dataset.

1. Suggesting changes to the data

When you create an Issue to suggest changes to the dataset (e.g. report an error), a template will be loaded that will guide you through collecting and providing the information we need to investigate.

  • Use a clear and descriptive title for the Issue to identify the problem.
  • Use the GitHub Issue search — check if the Issue has already been reported.
  • Check if the Issue has been fixed — try to reproduce it using the latest master or development branch in the repository.
  • If you find an Issue that addresses the error you have spotted, please add your comment and information to the existing Issue rather than creating a new one.

2. Submitting new data

When you create an Issue to submit new data on avian flu event in animals, a template will be loaded that will guide you through collecting and providing the information we need.

Please, note that new data submitted without information source(s) will not be considered. Please, provide the link to publicly available information source or to your repository, cloud, etc. where the information source can be accessed and downloaded.

3. Suggesting changes to the code

  • Use a clear and descriptive title for the Issue to identify the problem.
  • Use the GitHub Issue search — check if the Issue has already been reported.
  • Check if the Issue has been fixed — try to reproduce it using the latest master or development branch in the repository.
  • Provide a clear and concise description of the error, including what you expected to happen.

How to make a clean pull request

A pull request can be done to contribute to the code developed to visualize the dataset.

  • Create a personal fork of the project on Github.
  • Clone the fork on your local machine. Your remote repo on Github is called origin.
  • Add the original repository as a remote called upstream.
  • If you created your fork a while ago be sure to pull upstream changes into your local repository.
  • Create a new branch to work on. Branch from develop if it exists, else from master.
  • Implement/fix your feature, comment your code.
  • Follow the code style of the project, including indentation.
  • Push your branch to your fork on Github, the remote origin.
  • From your fork open a pull request in the correct branch. Target the project’s develop branch if there is one, else go for master.
  • If the maintainer requests further changes just push them to your branch. The pull request will be updated automatically.
  • Once the pull request is approved and merged you can pull the changes from upstream to your local repo and delete your extra branch(es).

Always write your commit messages in the present tense. Your commit message should describe what the commit, when applied, does to the code – not what you did to the code.

First-timers

The following guidelines will help you through your first steps in creating an issue and forking. Good luck!

Creating an issue

https://docs.github.com/en/issues/tracking-your-work-with-issues/creating-an-issue

Learn how to contribute to a project through forking

https://docs.github.com/en/get-started/quickstart/contributing-to-projects

License

This project is licensed under the CC BY-SA 4.0 License - see the CC BY-SA 4.0 file for details.

Contact

Francesco Branda. Email: francesco.branda.contact@gmail.com

References

This document was adapted from the open-source contribution guidelines accessible at: https://github.com/MarcDiethelm/contributing/blob/master/README.md