Skip to content

Latest commit

 

History

History
111 lines (86 loc) · 3.47 KB

CONTRIBUTING.md

File metadata and controls

111 lines (86 loc) · 3.47 KB

📝 CONTRIBUTING to Data-is-Awesome

Welcome to the Data-is-Awesome project!

🚀 Quickfacts

  • 🇬🇧 Speak English
  • ✨ Git is the only source of truth
  • 🌐 Use publicly available tools/resources
  • 🐍 Code in Python3.8 or higher
  • 📊 The data format is JSON!
  • 📝 Documentation and textbased stuff in Markdown
  • 🔗 The project stays detangled from GitHub!

Your contributions are valued and encourage you to get involved in various ways:

The project is designed to be easily accessible on GitHub. A simple clone grants you access to all project resources, including documentation, contributions, and ideas, available as Markdown files INSIDE the project.

💡 Idea for a new project?

Add a file to docs/backlog or create a new folder and start developing.

Your Feature README.md must include:

  • Research questions / Point of interest!
  • How to run
  • What it does / explanation
  • Sources / Links

🌍️ Languages:

#8orHigherBro Use Python3.8 or higher and adhere to the PEP 8 Python Styleguide. To adhere to the standards use pylint or autopep8 in your editor and development process (see Resources below).

What is PEP8? A standard for readable Python Code. Tools like pylint and autopep8 help you make your code look nice.

Generally these rules apply:

  • Linelength <80 characters. Docstrings 72
  • 4 spaces per indentaion level
  • 3 indentation levels max

Why Python3:

  • Supported on major platforms
  • Simple to read & write
  • Versatile: Data gathering, cleaning, visualizations, etc.

Why Python3.8?

  • Ubuntu 20.04 user here. Will be bumped in the future!

Resources:

📦️ New Features

A new feature adheres to the folder structure at the end of this chapter. Your fueature is documented, and able to be executed repeatadly. Do not use hidden or not publicly accessable resources hidden behind a barrier. Or provide a ladder to get over the barrier ;)

ALWAYS include a README.md containing the following segments, at least a brief explanation and how to run:

  • Title of your project
  • Research Qeustion / Why
  • How it works / is implemented
  • Usage: Commands to run this project
  • Overview of the project folder, users should know
  • Resources: Links to similar projects or inspiration: articles, videos, etc.
short_lower_case_consice_folder_name/
    README.md
    data/
    tests/
    docs/
    scripts/
    requirements.txt
    poc_my_feature.py

🐞 Issues / Bug-Reports

Bug-Report include:

  • Summary and/or background
  • Expected behavior / What you expect to happen
  • Actual Behavior / What really happens
  • Specific steps to reproduce
  • Include sample code
  • Notes & Further reading (Reasons you think it fails, stuff you tried, ideas)

🛠️ Pull requests

🚧 WORK IN PROGRESS

📂 Docs Folder

The docs/ folder 🚧 WORK IN PROGRESS

⚖️ License - Your Contribution is OPEN-SOURCE

All your contributions are belong to the public Any contributions you make to this project (code, documentation, or any other form) become part of the project under the MIT LICENSE. See LICENSE file.

By contributing to this project, you certify that:

  • Your contributions are licensed under the MIT License.
  • Your contributions are available publicly.
  • Your contributions can be used freely under the same terms as the rest of the project.

glhf 🚀