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 Scastie Links to Issue Template and/or README #2185

Closed
mwachs5 opened this issue Oct 14, 2021 · 13 comments
Closed

Add Scastie Links to Issue Template and/or README #2185

mwachs5 opened this issue Oct 14, 2021 · 13 comments
Labels
good first issue An issue whose fix is simple. Perfect for a new developer wanting to get involved!

Comments

@mwachs5
Copy link
Contributor

mwachs5 commented Oct 14, 2021

Type of issue: feature request | documentation

Impact: no functional change

Development Phase: request

Other information

If the current behavior is a bug, please provide the steps to reproduce the problem:

What is the current behavior?

We suggest Scastie in Issue Template, but we don't actually provide the links

What is the expected behavior?

The links are easy to find on the README and/or the Issue Template

We should include 3.5.0-RC1, 3.4.4 at least

Please tell us about your environment:

What is the use case for changing the behavior?

Scastie links are super handy!

@mwachs5 mwachs5 added the good first issue An issue whose fix is simple. Perfect for a new developer wanting to get involved! label Oct 14, 2021
@mwachs5
Copy link
Contributor Author

mwachs5 commented Oct 14, 2021

https://scastie.scala-lang.org/KtzZQ3nFTea9KoNh0tRqtg for Definition/Instance on 3.5.0-RC1

https://scastie.scala-lang.org/qgcsppKCShmlyIOr8qudqQ for simple example on 3.5.0-RC1

I'll need to test a 3.4.4 one

@Burnleydev1
Copy link
Contributor

Burnleydev1 commented Oct 14, 2021

Hello @mwachs5, please can try to work on this?

@mwachs5
Copy link
Contributor Author

mwachs5 commented Oct 14, 2021

Hi @Burnleydev1 , you could work on this, but you have also done a lot of docs so maybe #2107 would be more of a different challenge for you?

@Burnleydev1
Copy link
Contributor

okay @mwachs5 thanks, will check it out

@desirekaleba
Copy link
Contributor

Hello @mwachs5, Can I work on this issue?

@mwachs5
Copy link
Contributor Author

mwachs5 commented Oct 15, 2021

hi @desirekaleba , sure!

@desirekaleba
Copy link
Contributor

desirekaleba commented Oct 15, 2021

hi @desirekaleba , sure!

Is it about adding the provided links to the issue template? Because I tried going through both the issue template and the readme files, but I don't seem to find any section talking about Scastie. Or Is it about adding Scastie docs?

@mwachs5
Copy link
Contributor Author

mwachs5 commented Oct 16, 2021

Right @desirekaleba, there is nothing in the Issue Template or the README docs about Scastie yet. I think a good place to be add the links would be:

  1. in the README under Useful Resources: https://github.com/chipsalliance/chisel3#useful-resources

  2. and in the Issue Template (https://github.com/chipsalliance/chisel3/blob/master/.github/ISSUE_TEMPLATE.md) under This part (need to view the raw version of the page to see it):

**Other information**
 <!-- include detailed explanation, stacktraces, related issues, suggestions how to fix, links for us to have context, eg. Stack Overflow, gitter, etc -->

@ibukenya
Copy link

Hi @mwachs5, @debs-sifive I need some clarification please on handling issues.
If an issue is open, can any contributor start working on it?
How do I know that an issue is not assigned to a specific Contributor?
Please assign me an issue so I don't work on one that has been assigned already.
I have been learning basic commands around git.
I need to do some practice here on a good first issue!

@debs-sifive
Copy link
Contributor

@ibukenya it looks like @desirekaleba is working on this one; I cc'ed you on #2143, which I don't think anyone else is looking at yet.

@ibukenya
Copy link

@debs-sifive, concerning #2143 @mwachs5 mentioned that there is something about it.
Which one would you please assign to me going forward?

@ibukenya
Copy link

Hi @mwachs5, @debs-sifive, if there are any administrative tasks I could work on like data entry. I would gladly take them on.

mergify bot pushed a commit that referenced this issue Oct 21, 2021
* add scastie links (#2185)

* add scastie version (#2185)

Co-authored-by: Megan Wachs <[email protected]>
@mwachs5
Copy link
Contributor Author

mwachs5 commented Oct 25, 2021

Closed by #2189

@mwachs5 mwachs5 closed this as completed Oct 25, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue An issue whose fix is simple. Perfect for a new developer wanting to get involved!
Projects
None yet
Development

No branches or pull requests

5 participants