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.

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

Add contributing docs to README #224

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

Andrew-Chen-Wang
Copy link

Add contributing docs to README

  • Also adds hacking as an optional dependency for others to more easily install

@Andrew-Chen-Wang
Copy link
Author

I see this might be a duplicate of #119

@gi0baro
Copy link
Member

gi0baro commented Mar 5, 2024

@Andrew-Chen-Wang thank you for your contribution.
As you correctly discovered, this looks a duplicate of #119, which is opened by quite a long time, my bad.

To give you my personal ideas on this:

  • I'm more open to a make command for building a local environment and installing maturin, rather than hacking into project dependencies
  • I'm considering it might worth to actually produce a contribution guide in a separated file (eg: CONTRIBUTING.md) using a similar approach to what Pallets did on Flask and link that document in the readme, rather than bloating the readme with a long paragraph.. WDYT?

@Andrew-Chen-Wang
Copy link
Author

agree. docs/CONTRIBUTING sounds like a good place with a hyperlink to the file in the README

@gi0baro gi0baro force-pushed the master branch 2 times, most recently from ff9588a to 1814868 Compare May 1, 2024 22:24
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.

None yet

2 participants