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

Consider adding notes about unsafe usages to README #4

Closed
jchv opened this issue Nov 15, 2019 · 2 comments
Closed

Consider adding notes about unsafe usages to README #4

jchv opened this issue Nov 15, 2019 · 2 comments

Comments

@jchv
Copy link

jchv commented Nov 15, 2019

As users have pointed out on HN, since this is a direct conversion from C, there’s a lot of usages of unsafe. I think it would be nice to denote this in two ways:

  • A statement exclaiming such somewhere near the top, like “This is still a work in progress and contains memory-unsafe code as translated from C.”

  • A bullet point in the contributing section about reducing unsafe usages, as imaginably that would be a useful goal.

I am interested in trying to contribute and if I do this may be a focus area for me.

Cheers.

@samuela
Copy link
Owner

samuela commented Nov 16, 2019

Hey @jchv, thanks for pointing that out! Sadly there are still a bunch of unsafes lurking. I've added a section to the README that points this out and discusses the state of the project (a3c1776). I also added a section to CONTRIBUTING.md to address your second point (3a61bee). Hopefully these changes should help to clarify where the project stands, and where the opportunities for refactoring are!

The ultimate goal is to start from something imperfect but working and continually improve on it everyday.

@samuela
Copy link
Owner

samuela commented Nov 16, 2019

I'm going to go ahead and close for now, but feel free to keep the discussion going!

@samuela samuela closed this as completed Nov 16, 2019
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

No branches or pull requests

2 participants