Skip to content

Development and contributing guidelines updates#11560

Merged
marcellamaki merged 3 commits intolearningequality:release-v0.16.xfrom
MisRob:docs-updates
Nov 30, 2023
Merged

Development and contributing guidelines updates#11560
marcellamaki merged 3 commits intolearningequality:release-v0.16.xfrom
MisRob:docs-updates

Conversation

@MisRob
Copy link
Copy Markdown
Member

@MisRob MisRob commented Nov 27, 2023

Summary

  • Update contributing guidelines based on some latest discussions and experience
    • Suggest contributors ask for a reasonable amount of issues
    • Add a note on our response times
    • Add "How to connect section"
    • Remove "Kolibri" when possible so that guidelines can be copied/pasted more easily across other repositories
    • Marks important points in bold
    • Minor wording tweaks
  • Cleans up the guide on running another Kolibri instance in the developer documentation and adds information about Python version required to run pex files

Reviewer guidance


Testing checklist

  • Contributor has fully tested the PR manually
  • If there are any front-end changes, before/after screenshots are included
  • Critical user journeys are covered by Gherkin stories
  • Critical and brittle code paths are covered by unit tests

PR process

  • PR has the correct target branch and milestone
  • PR has 'needs review' or 'work-in-progress' label
  • If PR is ready for review, a reviewer has been added. (Don't use 'Assignees')
  • If this is an important user-facing change, PR or related issue has a 'changelog' label
  • If this includes an internal dependency change, a link to the diff is provided

Reviewer checklist

  • Automated test coverage is satisfactory
  • PR is fully functional
  • PR has been tested for accessibility regressions
  • External dependency files were updated if necessary (yarn and pip)
  • Documentation is updated
  • Contributor is in AUTHORS.md

- Suggest contributors ask for a reasonable
  amount of issues
- Add a note on our response times
- Add "How to connect section"
- Remove "Kolibri" when possible so that guidelines
  can be copied/pasted more easily accross other
  repositories
- Mark important point in bold
- Minor wording tweaks
- Remove duplicate or unnecessary information
- Cleanup titles
@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Nov 27, 2023

Copy link
Copy Markdown
Member

@marcellamaki marcellamaki left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this looks great, thank you @MisRob!

@marcellamaki marcellamaki merged commit 90df456 into learningequality:release-v0.16.x Nov 30, 2023
@MisRob MisRob deleted the docs-updates branch February 29, 2024 08:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

SIZE: small TAG: developer docs Technical docs and code comments TODO: needs review Waiting for review

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants