Skip to content

Latest commit

 

History

History
44 lines (29 loc) · 3.58 KB

github-guidelines.md

File metadata and controls

44 lines (29 loc) · 3.58 KB
Raw

GitHub Guidelines for ACT-R

New to GitHub?

GitHub has excellent documentation. If you are new to GitHub, please see their documentation on how to sign up, navigate, edit files and reviewing pull requests. In addition to official GitHub documentation, there are a lot of excellent articles and videos on how to use GitHub.

For reviewers

  • Submit a review with "changes requested" if any actions are needed from the author.
  • Submit with "approved" if you agree with the change, unless someone else in your organisation already approved the pull request (1 approval per organisation). This does not prevent you from requesting changes.
  • In addition to checking that the change in the pull request is correct, check whether or not the final call period is indicated correctly in the pull request description.
  • Keep your feedback relevant to the pull request. If you have feedback unrelated to the pull request, open an issue.

For pull request authors

  • Keep changes in the pull request about one topic only.
  • When updating your pull request, unless it is editorial, dismiss all reviews and re-request a review from the same reviewers.
  • Indicate the final call period in the pull request description:
    • 2 weeks for a new rule, or for major changes.
    • 1 week for smaller changes.
    • final call can be skipped for changes that do not change the meaning of the rule and don't change or remove test cases.
  • Review your own pull requests before you request changes.
  • Use the "reviewers wanted" label when the rule is ready for review.
  • For final calls, add the appropriate final call label, send an e-mail to the ACT-R mailing list, and remove the "reviewers wanted" label.

Note: If you do not have write access, you will not be able to add labels. Moderators are fairly pro-active about adding labels. If you find you need a label added, please ask the chair of the CG.

For people with write access

  • Don't edit or delete other people's posts.
  • Don't update, merge or close other people's pull requests.
  • Don't close other people's issues, unless you merged a pull request that completely resolves the issue.

If any of these need to happen, ask the ACT-R chair instead.

GitHub Permissions

  • By default, ACT-Rules participants will not be made collaborators on Github. Pull requests can not be approved. New pull requests can only be created via a code fork. Everyone will still be able to review pull requests.

  • ACT-Rules participants who are writing rules or actively reviewing rules can be given "read" access to the repository. This enables us to assign issues and pull requests to them. Read access will be revoked if someone leaves the community group.

  • Frequent contributors can be given write access upon request, and provided they have authored or reviewed up to three rules in the past year. The ACT-Rules chair will regularly review the list of people with write access and can revoke write access if they feel it is no longer necessary.

  • Admin access is restricted to the community group chair(s), and the W3C facilitator. Someone can be given temporary admin access for specific tasks. This access must be revoked after the task is completed.