Skip to content

Move Working with the Code from CONTRIBUTING.adoc to the wiki #26332

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

Closed
scottfrederick opened this issue Apr 30, 2021 · 3 comments
Closed

Move Working with the Code from CONTRIBUTING.adoc to the wiki #26332

scottfrederick opened this issue Apr 30, 2021 · 3 comments
Assignees
Labels
type: documentation A documentation update
Milestone

Comments

@scottfrederick
Copy link
Contributor

scottfrederick commented Apr 30, 2021

We'd like to move the Working with the Code section from CONTRIBUTING.adoc to a new page on the wiki to make it easier to maintain.

@scottfrederick scottfrederick self-assigned this Apr 30, 2021
@scottfrederick scottfrederick added the type: documentation A documentation update label Apr 30, 2021
@wilkinsona wilkinsona changed the title Move Working with the Code from CONTRIBUTION to the wiki Move Working with the Code from CONTRIBUTING.adoc to the wiki Apr 30, 2021
@scottfrederick scottfrederick added this to the 2.3.x milestone Apr 30, 2021
@dreis2211
Copy link
Contributor

dreis2211 commented Apr 30, 2021

If I may add my two cents here: I - as a contributor - always like having the contribution guides and everything that comes along with it inside the actual repository. Having that stuff in the Wiki always feels a bit decoupled and I personally barely look for instructions in the Wiki of a project. That might be wrong, but I wanted to give you the impression of someone that contributes from an outside perspective.

Moreover the Wiki has no versioning context by default, if I'm not mistaken. The switch from Maven to Gradle for example in the past was directly reflected in the specific markdown files inside the repo, which I personally see as a big benefit. I don't think we have that case at the moment, but it's something that came to my mind.

I might be biased and since I'm no first-time-contributor anymore my view on this might be distorted, but I'd appreciate a link to the new Wiki section in CONTRIBUTING.adoc as a first timer.

Cheers,
Christoph

@scottfrederick
Copy link
Contributor Author

Thanks for the feedback Christoph. As a frequent contributor this input is definitely valued. We started with a desire to put some of the more specific items like the existing Cloning the git repository on Windows and the suggestions in #25814 (comment) and #26309 on a wiki page to make them easier and faster to document, but ended up thinking it would be better to keep the "Working with the Code" content in one place.

Moreover the Wiki has no versioning context by default, if I'm not mistaken. The switch from Maven to Gradle for example in the past was directly reflected in the specific markdown files inside the repo, which I personally see as a big benefit.

We discussed the fact that some of this info might vary by release branch, but that seemed manageable in the wiki format since build changes typically apply to a range of release branches. We'll keep an eye on that going forward.

I'd appreciate a link to the new Wiki section in CONTRIBUTING.adoc as a first timer.

We planned to link in both directions - from CONTRIBUTING.adoc to the wiki page and from the wiki page to CONTRIBUTING.adoc.

@dreis2211
Copy link
Contributor

Thanks for following up on my comments, @scottfrederick

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: documentation A documentation update
Projects
None yet
Development

No branches or pull requests

2 participants