Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

doc: better readme + contributing.md #40

Merged
merged 2 commits into from
Dec 11, 2023
Merged

doc: better readme + contributing.md #40

merged 2 commits into from
Dec 11, 2023

Conversation

TomDarmon
Copy link
Contributor

@TomDarmon TomDarmon commented Dec 11, 2023 •
edited
Loading

Description of the goal of the PR

Description:

Changes this PR introduces (fill it before implementation)

  • Add make command to install dev reqs
  • Add CONTRIBUTING.md
  • Made the principal README more straightforward

Checklist before requesting a review

  • I have commented my code, particularly in hard-to-understand areas
  • I have typed my code
  • I have created / updated the docstrings
  • I have updated the README, if relevant
  • I have updated the requirements files if a new package is used
  • I have tested my code
  • The CI pipeline passes
  • I have performed a self-review of my code

@TomDarmon TomDarmon changed the title doc: contributing markdown doc: better readme + contributing.md Dec 11, 2023
@TomDarmon TomDarmon merged commit cb323d1 into dev Dec 11, 2023
1 check passed
@TomDarmon TomDarmon deleted the doc/user_friendly_readme branch December 11, 2023 15:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@tristanpepinartefact tristanpepinartefact tristanpepinartefact approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@TomDarmon @tristanpepinartefact