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

README: Clarify workflow with this repo #465

Closed
3 tasks done
fabulousgk opened this issue Jan 16, 2024 · 4 comments · Fixed by #493
Closed
3 tasks done

README: Clarify workflow with this repo #465

fabulousgk opened this issue Jan 16, 2024 · 4 comments · Fixed by #493
Assignees
Labels
Status: In Progress This issue/PR has ongoing work being done

Comments

@fabulousgk
Copy link
Contributor

Complete the following REQUIRED checkboxes:

  • I have thoroughly read and understand The Odin Project Contributing Guide
  • The title of this issue follows the location for request: brief description of request format, e.g. Foundations exercises: Add exercise for XYZ

The following checkbox is OPTIONAL:

  • I would like to be assigned this issue to work on it

1. Description of the Feature Request:

The readme currently states:

Do not submit your solutions to this repo, as any PRs that do so will be closed without merging.

We get questions seeking clarification of this on Discord fairly often. I suggest we edit it to something like this:

Go ahead and commit your changes and push them to your fork, but do not open a Pull Request to submit your changes to this repo. Doing so creates extra work for our maintainers as the PR will simply be closed.

2. Acceptance Criteria:

3. Additional Information:

@fabulousgk fabulousgk added the Status: Needs Review This issue/PR needs an initial or additional review label Jan 16, 2024
@CouchofTomato
Copy link
Member

If we're going to change this to offer up additoinal context we should probably explain why. Although we would like to avoid extra work, the reason we close them is because if we merged the PR's it would change the files for other students who forked the repo etc.

@fabulousgk
Copy link
Contributor Author

Yeah, I would be good with that as well, I think it is a good educational opportunity

@fabulousgk
Copy link
Contributor Author

Am I cleared to make this change?

@thatblindgeye
Copy link
Contributor

We have a somewhat similar issue in our JS exercise repo. Whatever change is made here should be made in all our exercise repos. For context, the JS exercise issue: TheOdinProject/javascript-exercises#380

I had mentioned moving the verbiage to the opening paragraph of the repo README, to make it more immediate of a disclaimer. @fabulousgk I'll assign you if you'd like to make the change in this repo, and we can keep this in mind for our other repos as well (the issue in our JS exercise repo may be assigned out to someone else).

@thatblindgeye thatblindgeye added Status: In Progress This issue/PR has ongoing work being done and removed Status: Needs Review This issue/PR needs an initial or additional review labels Feb 4, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Status: In Progress This issue/PR has ongoing work being done
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants