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

Good project onboarding experience #28

Closed
repi opened this issue Sep 10, 2020 · 5 comments
Closed

Good project onboarding experience #28

repi opened this issue Sep 10, 2020 · 5 comments
Assignees
Labels
a: documentation Improvements or additions to documentation t: help wanted Extra attention is needed

Comments

@repi
Copy link
Contributor

repi commented Sep 10, 2020

We discussed in the team meeting today (#26) that there would be a lot of value in making sure we have a great onboarding experiencing in this project and with new contributors that want to contribute to this once the project is public.

@MaikKlein have mentioned before that this was one of the challenges with the RLSL prototype that it was quite complex to set up and he needed to answer a lot of messages and support people that just wanted to try it out.

Let's try to make that as easy as possible with clear README, documentation, setup guides, examples, etc. Think @arirawr can help here once we are close to opening up. And would be great for every new dev that joins this project to improve the experience and comment in here what to change/fix that would be helpful to them.

@maxded also mentioned that it would be great to just have good references included to books and articles about how to learn more about building compilers, codegen etc as well.

@repi repi added a: documentation Improvements or additions to documentation t: help wanted Extra attention is needed labels Sep 10, 2020
@repi repi mentioned this issue Sep 10, 2020
@maxded
Copy link

maxded commented Sep 10, 2020

I'll keep track of all my learning sources and once I'm in a more comfortable position when it comes to compiler knowledge/experience, will share the most valuable sources!

@repi
Copy link
Contributor Author

repi commented Sep 18, 2020

@khyperia mentioned that she has done some work to improve this recently, and now when @termhn is joining in also that should be good test to see where we are at. So @termhn please do post stuff you run into that is unclear here and/or improve it yourself

@repi repi mentioned this issue Sep 18, 2020
repi added a commit that referenced this issue Oct 13, 2020
@repi
Copy link
Contributor Author

repi commented Oct 13, 2020

This is essentially what we talked about last week right @arirawr @khyperia to have a decent onboarding experience in the get-go with us opening up the project now soon (#55). And what @XAMPPRocky also started testing and checking?

@repi
Copy link
Contributor Author

repi commented Oct 21, 2020

Think we are close to closing this now, and ofc it can always be improved further but we are at a reasonable first level now which is great for the opening of the project. And then we can file more issues as they arrive.

Unless there is some last issues we want to fix here?

@XAMPPRocky
Copy link
Member

Yeah, I think we can close this issue for now, and open up more specific issues as they come up.

@repi repi closed this as completed Oct 22, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
a: documentation Improvements or additions to documentation t: help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

3 participants