Skip to content

Instantly share code, notes, and snippets.

@pmclanahan
Last active November 25, 2023 02:33
Show Gist options
  • Save pmclanahan/a162224376ca110b4a40 to your computer and use it in GitHub Desktop.
Save pmclanahan/a162224376ca110b4a40 to your computer and use it in GitHub Desktop.
Proposal Schema for contribute.json
{
// required
"name": "Name of the project. (e.g. Bedrock)",
"description": "Awesome website of sweetness",
"repository": {
"type": "git",
"url": "https://github.com/mozilla/bedrock"
},
// optional
"urls": {
"wiki": "https://wiki.mozilla.org/Mozilla.org",
"docs": "http://bedrock.readthedocs.org/",
"mailing-list": "https://www.mozilla.org/about/forums/#dev-mozilla-org",
"irc": "irc://irc.mozilla.org/#www",
"introduction": "https://wiki.mozilla.org/Webdev/GetInvolved/mozilla.org",
"tests": "https://ci.mozilla.org/job/bedrock/",
"bugs-list": "https://bugzilla.mozilla.org/buglist.cgi?query_format=advanced&bug_status=UNCONFIRMED&bug_status=NEW&product=www.mozilla.org",
"bugs-report": "https://bugzilla.mozilla.org/enter_bug.cgi?product=www.mozilla.org&component=Bedrock",
"bugs-mentored": "https://bugzilla.mozilla.org/buglist.cgi?f1=bug_mentor&o1=isnotempty&query_format=advanced&bug_status=NEW&product=www.mozilla.org&list_id=10866041",
"deployed-prod": "https://www.mozilla.org",
"deployed-stage": "https://www.allizom.org",
"deployed-dev": "https://www-dev.allizom.org"
},
"keywords": [
"python",
"less-css",
"django",
"html5",
"jquery"
]
}
@peterbe
Copy link

peterbe commented Jul 31, 2014

If we had "license" that should go under the "repository" container. The project doesn't have a license, the code does.

@peterbe
Copy link

peterbe commented Jul 31, 2014

If the repository url is worth pulling into its own block, it should probably point to the .git url so that it can be semantically and functionally different from the other (web) urls.

I disagree. The ".git url" is for doing a git clone, no? The web url is more useful. Issues, README, etc.

@peterbe
Copy link

peterbe commented Jul 31, 2014

-1 on a massive container for "urls". For example, why isn't the resposity->url key part of urls->repository.

Instead of

urls->deployed-stage, urls->deployed-dev

I would much rather see

deployed->stage, deployed->dev

big +1 on the new "keywords" section. I love that because if your skill is "flask" and "angular" that's most likely how you're going to search for projects to contribute to.

Copy link

ghost commented Jul 31, 2014

Do we even need deployed in there? Why not just

urls->stage, urls->production

I would have inferred that this is where code for those branches/tags/whatnot is deployed.

Copy link

ghost commented Jul 31, 2014

@peterbe I think the reason repository is not part of urls is because it is mandatory, and @pmclanahan wanted to keep all of those together in one place.

Also, might something like this work?

https://gist.github.com/ossreleasefeed/e0c52e9f1dac8bff943d/ff0821aaf35fcb39b34dcc2874379933a38a4498

perhaps even break out bugs into it's own group?

https://gist.github.com/ossreleasefeed/e0c52e9f1dac8bff943d

@bensternthal
Copy link

Some thoughts;

  1. wiki - perhaps this should be homepage, (im stealing from package.json) but wiki seems tech dependent the idea here is where is the project hub.
  2. introduction - this seems weird to me, this should be part of the project homepage or docs. Not sure if it's important or obvious enough to be in this.
  3. +1 to https://gist.github.com/pmclanahan/a162224376ca110b4a40#comment-1270257 bugs{} me likes this approach.

Generally looks good, I like keeping this abstracted from our current tech choices (wiki bugzilla) and my comments are mostly around that.

@pmclanahan
Copy link
Author

I've created a real repo for this: https://github.com/mozilla/contribute.json

Let's continue the discussion there in issues or PRs. I'm finding it harder to follow the discussions here, and we can segment them into issues with specific areas there.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment