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.md #679

Merged
merged 11 commits into from
May 4, 2022
Merged

Add CONTRIBUTING.md #679

merged 11 commits into from
May 4, 2022

Conversation

yannham
Copy link
Member

@yannham yannham commented Apr 8, 2022

No description provided.

@github-actions github-actions bot temporarily deployed to pull request April 8, 2022 16:57 Inactive
@yannham yannham requested a review from aspiwack April 11, 2022 08:38
@github-actions github-actions bot temporarily deployed to pull request April 11, 2022 08:41 Inactive
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
yannham and others added 2 commits April 11, 2022 11:51
Co-authored-by: Arnaud Spiwack <arnaud.spiwack@tweag.io>
Co-authored-by: Arnaud Spiwack <arnaud.spiwack@tweag.io>
@github-actions github-actions bot temporarily deployed to pull request April 11, 2022 09:55 Inactive
yannham and others added 2 commits April 11, 2022 12:07
Co-authored-by: Arnaud Spiwack <arnaud.spiwack@tweag.io>
Co-authored-by: Arnaud Spiwack <arnaud.spiwack@tweag.io>
@github-actions github-actions bot temporarily deployed to pull request April 11, 2022 10:12 Inactive
Co-authored-by: Arnaud Spiwack <arnaud.spiwack@tweag.io>
@github-actions github-actions bot temporarily deployed to pull request April 11, 2022 10:35 Inactive
@yannham
Copy link
Member Author

yannham commented Apr 11, 2022

I implemented the suggestions and moved the setup development environment part to a separate HACKING.md.

@yannham yannham requested a review from aspiwack April 11, 2022 11:37
@github-actions github-actions bot temporarily deployed to pull request April 11, 2022 11:38 Inactive
@github-actions github-actions bot temporarily deployed to pull request April 11, 2022 15:22 Inactive
@yannham yannham requested a review from garbas April 29, 2022 09:22
Copy link
Contributor

@garbas garbas left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I gave it a quick read but I didn't test all of the command. The whole thing looks very professional :)

Would it be possible to include this on the website? Or at least point to this markdown files.

@yannham
Copy link
Member Author

yannham commented May 3, 2022

I haven't had time to try to improve the WASM situation. This guide is still useful, so I propose to merge it as it is and open an issue to remember to try a better solution for building the WASM REPL.

@garbas given this is markdown and part of the nickel flake, it wouldn't be hard to either include it as a page or point to it. I wonder where that should go, though? It doesn't concern random prospective users visiting the website, but it may fit somewhere indeed.

@garbas
Copy link
Contributor

garbas commented May 3, 2022

@garbas given this is markdown and part of the nickel flake, it wouldn't be hard to either include it as a page or point to it. I wonder where that should go, though? It doesn't concern random prospective users visiting the website, but it may fit somewhere indeed.

It is fine that this is here. It would be trivial to just copy this two files during the build process of documentation.

@yannham
Copy link
Member Author

yannham commented May 3, 2022

Sorry, I didn't make my question clear enough: I meant where should it appear on the website, as a page or a link.

@garbas
Copy link
Contributor

garbas commented May 3, 2022

I think having a link with some short description would be a good first step for now.

@aspiwack
Copy link
Member

aspiwack commented May 4, 2022

I really doubt that it has value to add either document to the website.

@github-actions github-actions bot temporarily deployed to pull request May 4, 2022 07:11 Inactive
@yannham yannham merged commit 70e4297 into master May 4, 2022
@yannham yannham deleted the doc/contributing branch May 4, 2022 07:30
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.

3 participants