Skip to content

Add CONTRIBUTING.md#238

Merged
lundberg merged 1 commit intolundberg:masterfrom
morenoh149:hm-add-contributing
Jul 20, 2023
Merged

Add CONTRIBUTING.md#238
lundberg merged 1 commit intolundberg:masterfrom
morenoh149:hm-add-contributing

Conversation

@morenoh149
Copy link
Copy Markdown
Contributor

@morenoh149 morenoh149 commented Jun 15, 2023

First stab at adding a contributing guideline. Shows how to install dev dependencies and how to run dev tasks.

Closes #237

Screen Shot 2023-06-15 at 2 43 00 PM
Screen Shot 2023-06-15 at 2 47 51 PM

@morenoh149 morenoh149 force-pushed the hm-add-contributing branch from f91addc to 5cd1745 Compare June 15, 2023 18:47
@morenoh149 morenoh149 force-pushed the hm-add-contributing branch 2 times, most recently from 3eb92b4 to 6e64d28 Compare July 11, 2023 17:19
@codecov
Copy link
Copy Markdown

codecov bot commented Jul 19, 2023

Codecov Report

Patch and project coverage have no change.

Comparison is base (33438de) 100.00% compared to head (9f0256e) 100.00%.

Additional details and impacted files
@@            Coverage Diff            @@
##            master      #238   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           20        20           
  Lines         2758      2758           
  Branches       417       417           
=========================================
  Hits          2758      2758           

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

@lundberg
Copy link
Copy Markdown
Owner

I think we should exclude the contributing file from the manifest, right?

e.g. add to MANIFEST.in ...

exclude CONTRIBUTING.md

Shows how to run tests and linting.
@morenoh149 morenoh149 force-pushed the hm-add-contributing branch from 6e64d28 to 9f0256e Compare July 20, 2023 17:31
@lundberg
Copy link
Copy Markdown
Owner

Looks good, thanks for a good start of this file @morenoh149.

There's more stuff we can add later, e.g. mention how to setup the environment with nix etc.

@lundberg lundberg merged commit d304a85 into lundberg:master Jul 20, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add CONTRIBUTING.md

2 participants