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

draft changes in contributing-md #407

Merged
merged 6 commits into from Mar 15, 2023
Merged

draft changes in contributing-md #407

merged 6 commits into from Mar 15, 2023

Conversation

jcolomb
Copy link
Contributor

@jcolomb jcolomb commented Mar 8, 2023

I think some links should be modified at the end, I do not know about shell-novice and co

Please delete this line and the text below before submitting your contribution.


Thanks for contributing! If this contribution is for instructor training, please send an email to checkout@carpentries.org with a link to this contribution so we can record your progress. You’ve completed your contribution step for instructor checkout just by submitting this contribution.

Please keep in mind that lesson maintainers are volunteers and it may be some time before they can respond to your contribution. Although not all contributions can be incorporated into the lesson materials, we appreciate your time and effort to improve the curriculum. If you have any questions about the lesson maintenance process or would like to volunteer your time as a contribution reviewer, please contact The Carpentries Team at team@carpentries.org.


I think some links should be modified at the end, I do not know about shell-novice and co
@jcolomb jcolomb changed the title draft changes draft changes in contributing-md Mar 8, 2023
Copy link
Contributor

@zkamvar zkamvar left a comment

Choose a reason for hiding this comment

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

This looks good to me. Thank you for starting this!

I think the entire "Where to contribute" section can be rewritten or removed because that served as a signpost when the tools and content were bundled together, but that can be addressed later.

Could you add your name to the DESCRIPTION as a contributor? (here is a guide for the format).

I am currently trying waiting for #405 to pass and then I will merge this and fix any tests that may need fixing.

inst/templates/contributing-template.txt Outdated Show resolved Hide resolved
inst/templates/contributing-template.txt Show resolved Hide resolved
inst/templates/contributing-template.txt Outdated Show resolved Hide resolved
inst/templates/contributing-template.txt Outdated Show resolved Hide resolved
before starting work.
Please do *not* work directly in your `gh-pages` branch,
since that will make it difficult for you to work on other contributions.
discuss with the maintainer about what branch to use before starting to work.
Copy link
Contributor

Choose a reason for hiding this comment

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

I believe this entire sentence can be deleted since GitHub flow is described below.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I think I would keep it especially for people used to the old workflow that used the gh-page branch as the published copy.

Copy link
Contributor Author

@jcolomb jcolomb left a comment

Choose a reason for hiding this comment

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

I think it would be good to go through the list of links in the end, change things that should be modified with FIXME and see that other links are not related to old template

before starting work.
Please do *not* work directly in your `gh-pages` branch,
since that will make it difficult for you to work on other contributions.
discuss with the maintainer about what branch to use before starting to work.
Copy link
Contributor Author

Choose a reason for hiding this comment

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

I think I would keep it especially for people used to the old workflow that used the gh-page branch as the published copy.

@zkamvar
Copy link
Contributor

zkamvar commented Mar 13, 2023

This is currently failing because the main branch needs to be merged to address the fixes from #405. I will go ahead and do that from my end.

Copy link
Contributor Author

@jcolomb jcolomb left a comment

Choose a reason for hiding this comment

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

add modify

@jcolomb
Copy link
Contributor Author

jcolomb commented Mar 15, 2023

@zkamvar now that #405 is merged, can we merge or do you want to discuss keeping the section about the branch being head

@zkamvar
Copy link
Contributor

zkamvar commented Mar 15, 2023

Sorry about the lack of communication on my end; Aside from the chaos of the last week, I had an emergency situation yesterday that took me away from my desk and could not address this. Honestly, it never usually takes me this long to address issues, especially something as straightforward as modifying a template file.

can we merge or do you want to discuss keeping the section about the branch being head

For me, it is valuable to keep an acknowledgement of how we used to do things so that folks who transition to using The Workbench from styles know the difference, but it should be an aside. My reasoning is that this document should accurately describe our current practices to allow people to quickly and confidently make a contribution.

The discussion of the branch names was a relic from a time when lessons often had a default branch that was different than the generally accepted default branch (and even at that, our lesson repositories were not consistent in this respect), which is now no longer relevant.

@jcolomb
Copy link
Contributor Author

jcolomb commented Mar 15, 2023

no problem, you are still one of the fastest people around even when you fell you are slow :)

I simplified a bit, taking our remnants from previous workflows.

@zkamvar
Copy link
Contributor

zkamvar commented Mar 15, 2023

Thank you @jcolomb! T

@zkamvar zkamvar merged commit 9f9844a into carpentries:main Mar 15, 2023
11 of 12 checks passed
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.

None yet

2 participants