How does a contributor find the repo in order to raise an issue or contribute?

[EmmaJP]

I could not find any links to this Github from anywhere in the https://bbc.github.io/gel/ website. Not even from the less obviously signposted contributors page.

Also, the very obviously signposted survey at the bottom of the homepage is "now closed".

How does someone (eg. a BBC dev or champion) feedback on or contribute to the content of the site?

[micmath]

Thanks Emma,

Over-literal Michael speaking => I'm assuming you are asking that question rhetorically as a way to point out that there aren't any guidelines for what the project policy and preferences are for this issue, since you yourself have already provided feedback on or contributed to the content of this site multiple times now. In which case would you rename this issue to something more actionable like "Publish a project Contribution Guideline explaining preferred process for raising an issue or contributing". The technical steps of operating git are easily found in about a million places, but the Contribution Guideline should include things like "ask before forking: there may already be work underway on your issue" etc. @EmmaJP would you like to make a start on this? Or suggest some existing examples (even better if from a BBC open-source projects) to use as a model?

Also please break the completely unrelated point regarding "Fix link to Feedback" onto a different issue so they don't get muddled together in one thread.

[EmmaJP]

Actually, it was a much more literal question...

How does someone find the github in order to raise an issue or contribute?

I'm fortunate to have BBC github access and know the name of the repo, and it was still a helluva round the houses route in to create this issue. If the this repo is intended to be open source, surely we should make the route to do so a little less difficult.

[micmath]

It's a public repo, so anyone can view anything -- this thread for example -- and anyone with a github account can create an issue, inside or outside The BBC org. So, in regards to findability, you could always Google It. But I'm confused about what you would suggest: is there some idea you have that would make it more findable? Care to share examples of how other projects have done it well, etc?

[micmath]

On the premise that findability would benefit from having a Contributor's Page, I'm starting a list of example CPs that we can use as a model, please feel free to add:

• https://docs.kinto-storage.org/en/stable/community.html#how-to-contribute
• https://github.com/emberjs/ember.js/blob/master/CONTRIBUTING.md
• https://github.com/pixijs/pixi.js/blob/dev/.github/CONTRIBUTING.md

[micmath]

We could add a link to the Contributor's Page in the footer of our documentation site, for example.

[EmmaJP]

How does someone less in-the-know get from https://bbc.github.io/gel/ to https://github.com/bbc/gel? A Google search seems a rather scenic route.

I suggest that https://bbc.github.io/gel/contributors/ should have a direct link to https://github.com/bbc/gel to encourage the welcomed feedback. Perhaps the following existing sentence could be modified and include a link:

"To open a pull request please visit this project's github page and get forking! We can't wait to see what you've got to share."

Suggestion:
"To provide feedback or open a pull request, please visit this project's github and get forking! We can't wait to see what you've got to share."

[EmmaJP]

Apologies that the wording when I raised this issue wasn't clearer. I had hoped my first comment/description would explain the title.

[micmath]

I didn't immediately connect that there was a difference between "the repo" and the documentation site -- in my head the documentation site is in the repo, so I was confused how anyone viewing the site wouldn't be able to find the repo. The penny dropped though, and I see what you mean :)