search

redhat-documentation / modular-docs

Modular Documentation Project provides guidelines and examples for writing technical documentation using a modular framework.
Creative Commons Attribution Share Alike 4.0 International
80 stars 67 forks source link

Update the contribution instructions #230

Closed rolfedh closed 4 months ago

rolfedh commented 4 months ago

Fixes https://github.com/redhat-documentation/modular-docs/issues/225 Supersedes: https://github.com/redhat-documentation/modular-docs/pull/226

rolfedh commented 4 months ago

@mjahoda @Jenny-Anne. I had to start a new branch because of some configuration issues with my fork, which was using the obsolete master branch. Would you please review this new PR? I'm proposing a completely revamped set of instructions. WDYT? Preview link: https://github.com/redhat-documentation/modular-docs/blob/cddc4c09642be123debac3907083a76ad6ad56f7/CONTRIBUTING.md

rolfedh commented 4 months ago

I believe GitHub may have merged and closed this pull request automatically as a result of some of my command operations. Not intentional on my part.

Jenny-Anne commented 4 months ago

For what it's worth, the preview looks good to me :) I didn't do the step to configure an upstream remote when I set up my local repository. Is that a necessary step? It might be worth running through the process in the mod docs call.

Also, I didn't realise that uncommented requests were automatically approved after one week as per the last line - good to know.

Thanks again for updating the page.

rolfedh commented 4 months ago

configure an upstream remote

Yes. This is a required step for creating pull requests when you want to contribute to the repo. I'll be glad to demo this any time.

uncommented requests were automatically approved after one week as per the last line

Yes. This was new to me, too. I'm not sure we're following this in practice. I preserved that information from the original version because it seemed like a team decision. We should probably discuss whether this is still true. I've added it to the agenda for discussion.