add 'Contributing' page #72
Conversation
✅ Deploy Preview for gracious-brattain-bdd606 ready!
To edit notification comments on pull requests, go to your Netlify site settings. |
There was a problem hiding this comment.
Wow thanks @wotnak! This is great!
The page is added under the Community menu section. As noted in the issue, top-level link could also be a good place for it.
Yea I think "Community" is the right place for this...
Exact placement in the Community menu section is also for discussion. Currently, it is placed as the last item, but maybe moving it higher could make it more visible.
... and in my opinion this should be the first time under the "Community" menu!
Open to others' thoughts on this, but it seems like a good introduction to the "Community" section. And makes more sense to put this as the top item followed by the existing "Code of Conduct" item.
There was a problem hiding this comment.
Thanks for working on this @wotnak
This current CONTRIBUTING.md at the root of our repo was originally designed for the website. It serves this purpose well. But I don't think it serves the Github Contributing guidelines very well - it is too verbose IMO and could link to most of this content on farmOS.org. https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/setting-guidelines-for-repository-contributors#adding-a-contributing-file
I have an idea: what if we move the farmOS/farmOS CONTRIBUTING.md to this repo alongside the existing community content: https://github.com/farmOS/farmOS.org/tree/main/src/content/community That would simplify the site-data.js and source path logic in the repo. I think this change introduces some unnecessary compelxity.
We could then create a new simpler CONTRIBUTING.md in our farmOS/.github that links to this new farmOS.org contributing page.
|
More specifically I think our Github And it would make this PR much simpler :-) |
|
I like this! Good suggestions @paul121, and thanks again @wotnak for making it happen! I will go ahead and squash+merge this, and then I will remove
Let's figure these out in follow-up(s)... I imagine each repo will need its own, since guidelines vary by project. A catch-all file in .github/CONTRIBUTING.md that directs to the website will suffice in the meantime. |
We are moving this from github.com/farmOS/farmOS/CONTRIBUTING.md. Here is the commit that originally moved it from the old farmOS.org repo: farmOS/farmOS@4f9797e
mstenta
force-pushed
the
contributing-page
branch
from
10b1ca1
to
355d5e2
Compare
Adds 'Contributing' page as described in #62.
The page is added under the Community menu section. As noted in the issue, top-level link could also be a good place for it. Exact placement in the Community menu section is also for discussion. Currently, it is placed as the last item, but maybe moving it higher could make it more visible.