decryptofy / scarr Goto Github PK

I have familiarity with VScode, but not with using Jupyter Notebook. I think this may be the case for many OSU students. In my brief experience running jupyter notebook through the browser is a good deal slower with a less intuitive interface. I would like to put together a tutorial for using VScode and running the first jupyter notebook on it (0_scarr_start_here_V2.ipynb) for true beginners like me.

Please let me know if there's any feedback you would like to provide for this suggestion (even if it is that this isn't a good enough idea).
Thank you!

Hello! The purpose of this issue is to request expansion of the documentation in the contributor’s guide to formalize it. The “Contributing Process” is clearly stated as TBD, but it would be helpful to potentially add more specificity to the contributor’s guide, perhaps via a more extensive description of how to contribute to each of the following: development, documentation, feature requests, patches, bug reporting, and user support. It may be even more helpful to include links to pull requests and successful prior instances of each form of contribution for future contributors to look to for guidance. Below is one possible way to begin adding more detail to the Contributor’s Guide:

Another idea to improve this documentation through the same lens is to include a “Steps to a Successful Developer Contribution” section. I have seen some large and successful open-source projects include one as part of their documentation for contributors. The idea below could potentially be a starting point to introduce this:

I plan to follow up on this suggestion in the coming weeks with pull requests that will outline specific, actionable, and more thorough changes for others to review and refine.

I found a few typos and grammatical improvements that could be made in this file.

Ex:
Possessive singular of class:

Sentence structure and missing commas:

Is it alright if I make these changes and fix a couple other minor typos?

Steps to reproduce:

1. Navigate to https://github.com/decryptofy/scarr
2. Scroll down to Table of Contents
3. Click "Contributing (inbound = outbound)"
4. Expected behavior: URL is updated in browser and browser navigates to contribution section of README.md
   Actual behavior: URL is updated but navigation does not occur

Before click:

After click:

OS: Windows 11
Browser: Chrome Version 125.0.6422.76 (Official Build) (64-bit)