search

traja-team / traja

Python tools for spatial trajectory and time-series data analysis
https://traja.readthedocs.io
MIT License
98 stars 25 forks source link

Add initial contributing guide #73

Closed WolfByttner closed 3 years ago

WolfByttner commented 3 years ago

To widen access to this project, we will write a contributors guide. This will help people get up to speed with the goals of Traja, and how to contribute to these goals.

I am looking for feedback - this document is not finished and I want current contributors to give their opinion on how we can make Traja work better for new starters.

codecov[bot] commented 3 years ago

Codecov Report

Merging #73 (d99d24b) into master (f87978d) will increase coverage by 1.73%. The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##           master      #73      +/-   ##
==========================================
+ Coverage   75.66%   77.40%   +1.73%     
==========================================
  Files          24       26       +2     
  Lines        2466     2633     +167     
==========================================
+ Hits         1866     2038     +172     
+ Misses        600      595       -5
Impacted Files Coverage Δ
traja/dataset/pituitary_gland.py 100.00% <0.00%> (ø)
traja/stats/brownian.py 100.00% <0.00%> (ø)
traja/models/train.py 94.55% <0.00%> (+6.73%) :arrow_up:

Continue to review full report at Codecov.

Legend - Click here to learn more Δ = absolute <relative> (impact), ø = not affected, ? = missing data Powered by Codecov. Last update f87978d...d99d24b. Read the comment docs.