Improve contributing process

Proposer
Floppy
State

Accepted

Vote Score

0

Age

3648 days


@Floppy edited _layouts/page.html - almost 10 years ago
      <li><a href="http://votebot.openpolitics.org.uk">Open Votes</a></li>
      <li><a href="{{site.baseurl}}contributing.html">How to Contribute</a></li>
    </ul>
    <a href="http://prose.io/#openpolitics/manifesto/edit/gh-pages/{{page.path}}" class='btn btn-primary navbar-btn pull-right'>
    <a href="https://github.com/openpolitics/manifesto/edit/gh-pages/{{page.path}}" class='btn btn-primary navbar-btn pull-right'>
      Edit Page
      <i class="fa fa-pencil"></i>
    </a>
@Floppy edited contributing.md - almost 10 years ago

published: true

  1. Get a GitHub account and log in.
  2. Find the page you want to edit, and click the Edit link at the top right.
  3. Make your change in the editor.
  4. Click the Save icon, enter a description of your change, and hit commit.
  1. Find the page you want to edit, and click the Edit Page button at the top right.
  2. Log in, or sign up for a GitHub account if you don't already have one. GitHub is the system that stores all the changes made to the manifesto, so you need an account to contribute.
  3. Make your change in the editor. Formatting uses Markdown.
  4. Once you've made your change, enter a short comment in the box that says Update {filename}.
  5. Click the 'Commit Changes' button.

Your change will be entered into the pull request queue for discussion before being merged into the master version.

Your change will be entered into the discussion queue. Some existing contributors will have to agree to the change before it's merged into the master version (see below for how that works).

If you're more familiar with GitHub, you can of course use the standard fork / pull request model. The repository is openpolitics/manifesto.

If you're more familiar with GitHub, you can of course use the standard fork / pull request model. s

The Rules

  • Anything can be changed.
  • All contributions and discussions are public, and should take place as part of a pull request.
  • All contributions and discussions should be public, ideally on GitHub.
  • Plain English is essential - follow the GDS style guide if you can, or use Hemingway to test readability. Try to avoid political weasel-words.
  • Make changes small, self-contained, and simple. Large changes will take a lot longer to get agreed upon and merged. Small is agile.
  • All content is public domain. By submitting a change, you agree that you are putting your work into the public domain. See the full license for details.

  • General GitHub documentation

  • GitHub pull request documentation

Floppy

@Floppy - almost 10 years ago

Dropped prose.io, and updated instructions. Makes logging in a lot easier for new users

PaulJRobinson

@PaulJRobinson - almost 10 years ago

How can I check out the new system if this hasn't merged yet? Whilst I can imagine the Github editting system to be extremely functional and rugged (and not lose those edits you mentioned) I'm not convinced it will be a more appealing option to the non-techie.

Floppy

@Floppy - almost 10 years ago

A good point. Try this, it'll be the same: - Open an anonymous browser window, or log out of github - Visit https://github.com/openpolitics/manifesto/edit/gh-pages/contributing.md (or some other page) - Try to edit

Floppy

@Floppy - almost 10 years ago

The github UI is more complex, but prose.io's login handling is so fraught with error that I think this is an improvement.

Floppy

@Floppy - almost 10 years ago

Actually it looks like prose's auth handling is currently broken, so hopefully this will get a fix and we can go back to using it. See https://github.com/prose/prose/issues/643

Floppy

@Floppy - almost 10 years ago

Interestingly, we're not the first to switch back for exactly this reason: https://github.com/Project-Interoperability/project-interoperability.github.io/commit/017be3a3c60b56261ec1ee68cec037bc86c14790

Will see if I can find time to try to fix this in prose, unless they come up with a fix fairly soon.

Floppy

@Floppy - almost 10 years ago

I think this PR would be good to merge as the prose flow is currently broken, but I will change it back as soon as it's fixed, that's a promise, as I agree the UI is better for new users.

philipjohn

@philipjohn - almost 10 years ago

👍 with one suggested tweak to the text: - "Some existing contributors will have to agree to the change before it's merged into the master version" - "There will then be a vote, and possibly debate, amongst contributors on whether to adopt the change"

Just because the former could be interpreted as sounding like it goes through some sort of self-appointed approval committee rather than a democratic vote.

@Floppy edited _layouts/page.html - almost 10 years ago
      <li><a href="http://votebot.openpolitics.org.uk">Open Votes</a></li>
      <li><a href="{{site.baseurl}}contributing.html">How to Contribute</a></li>
    </ul>
    <a href="http://prose.io/#openpolitics/manifesto/edit/gh-pages/{{page.path}}" class='btn btn-primary navbar-btn pull-right'>
    <a href="https://github.com/openpolitics/manifesto/edit/gh-pages/{{page.path}}" class='btn btn-primary navbar-btn pull-right'>
      Edit Page
      <i class="fa fa-pencil"></i>
    </a>
@Floppy edited contributing.md - almost 10 years ago

published: true

  1. Get a GitHub account and log in.
  2. Find the page you want to edit, and click the Edit link at the top right.
  3. Make your change in the editor.
  4. Click the Save icon, enter a description of your change, and hit commit.
  1. Find the page you want to edit, and click the Edit Page button at the top right.
  2. Log in, or sign up for a GitHub account if you don't already have one. GitHub is the system that stores all the changes made to the manifesto, so you need an account to contribute.
  3. Make your change in the editor. Formatting uses Markdown.
  4. Once you've made your change, enter a short comment in the box that says Update {filename}.
  5. Click the 'Commit Changes' button.

Your change will be entered into the pull request queue for discussion before being merged into the master version.

Your change will be entered into the discussion queue. There will then be a vote, and possibly debate, amongst contributors on whether to adopt the change.

If you're more familiar with GitHub, you can of course use the standard fork / pull request model. The repository is openpolitics/manifesto.

If you're more familiar with GitHub, you can of course use the standard fork / pull request model. s

The Rules

  • Anything can be changed.
  • All contributions and discussions are public, and should take place as part of a pull request.
  • All contributions and discussions should be public, ideally on GitHub.
  • Plain English is essential - follow the GDS style guide if you can, or use Hemingway to test readability. Try to avoid political weasel-words.
  • Make changes small, self-contained, and simple. Large changes will take a lot longer to get agreed upon and merged. Small is agile.
  • All content is public domain. By submitting a change, you agree that you are putting your work into the public domain. See the full license for details.

  • General GitHub documentation

  • GitHub pull request documentation

Floppy

@Floppy - almost 10 years ago

Good change, have integrated it.

@Floppy edited _layouts/page.html - almost 10 years ago
      <li><a href="http://votebot.openpolitics.org.uk">Open Votes</a></li>
      <li><a href="{{site.baseurl}}contributing.html">How to Contribute</a></li>
    </ul>
    <a href="http://prose.io/#openpolitics/manifesto/edit/gh-pages/{{page.path}}" class='btn btn-primary navbar-btn pull-right'>
    <a href="https://github.com/openpolitics/manifesto/edit/gh-pages/{{page.path}}" class='btn btn-primary navbar-btn pull-right'>
      Edit Page
      <i class="fa fa-pencil"></i>
    </a>
@Floppy edited contributing.md - almost 10 years ago

published: true

  1. Get a GitHub account and log in.
  2. Find the page you want to edit, and click the Edit link at the top right.
  3. Make your change in the editor.
  4. Click the Save icon, enter a description of your change, and hit commit.
  1. Find the page you want to edit, and click the Edit Page button at the top right.
  2. Log in, or sign up for a GitHub account if you don't already have one. GitHub is the system that stores all the changes made to the manifesto, so you need an account to contribute.
  3. Make your change in the editor. Formatting uses Markdown.
  4. Once you've made your change, enter a short comment in the box that says Update {filename}.
  5. Click the 'Commit Changes' button.

Your change will be entered into the pull request queue for discussion before being merged into the master version.

Your change will be entered into the discussion queue. There will then be a vote, and possibly debate, amongst contributors on whether to adopt the change.

If you're more familiar with GitHub, you can of course use the standard fork / pull request model.

If you're more familiar with GitHub, you can of course use the standard fork / pull request model. The repository is openpolitics/manifesto.

The Rules

  • Anything can be changed.
  • All contributions and discussions are public, and should take place as part of a pull request.
  • All contributions and discussions should be public, ideally on GitHub.
  • Plain English is essential - follow the GDS style guide if you can, or use Hemingway to test readability. Try to avoid political weasel-words.
  • Make changes small, self-contained, and simple. Large changes will take a lot longer to get agreed upon and merged. Small is agile.
  • All content is public domain. By submitting a change, you agree that you are putting your work into the public domain. See the full license for details.

  • General GitHub documentation

  • GitHub pull request documentation