Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improving on PR review process #132

Closed
2 of 3 tasks
romaninsh opened this issue Sep 24, 2018 · 0 comments
Closed
2 of 3 tasks

Improving on PR review process #132

romaninsh opened this issue Sep 24, 2018 · 0 comments
Labels
tag/platform Anything relating to the Fomantic platform as a whole type/chore Anything which is a project chore type/discussion Anything which is up for discussion

Comments

@romaninsh
Copy link

romaninsh commented Sep 24, 2018

Feature Request

Description

If Fomantic is to dash ahead with accepting some new features the one possible downfall would be the stability and introduced inconsistency. I propose that several "acceptance criteria" are introduced for new features and are maintained by contributors at all times:

  • A process for reviewing new PRs to be documented
  • Reviewer (who is not author of PR) is selected who is familiar with the process
  • PR can only be accepted if Reviewer have approved it

Example Review criteria:

  • Minor features must amend the documentation where required
  • Major new modules must add a new documentation page
  • New usage cases should be included on the UI testing page
  • Test suite should snapshot new features or modifications
  • New modules must have at least one test-case added to the "what's new" page.
  • Major feature change can only have a mention on the release
  • Any changes imported from SUI must reference original release note/PR
  • Code/Docs/Examples must be stylistically consistent with the rest
  • Modules with incomplete/unfinished API should be marked as "beta"

This is just an example, feel free to tweak. Following a criteria and keeping new feature quality in-check as well avoiding breaking changes is very important.

@romaninsh romaninsh changed the title Improving on PR review Improving on PR review process Sep 24, 2018
@y0hami y0hami added type/discussion Anything which is up for discussion tag/platform Anything relating to the Fomantic platform as a whole labels Sep 24, 2018
@ColinFrick ColinFrick added 🚥 Testing type/chore Anything which is a project chore tag/platform Anything relating to the Fomantic platform as a whole and removed tag/platform Anything relating to the Fomantic platform as a whole labels Sep 24, 2018
@y0hami y0hami closed this as completed Oct 15, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
tag/platform Anything relating to the Fomantic platform as a whole type/chore Anything which is a project chore type/discussion Anything which is up for discussion
Projects
None yet
Development

No branches or pull requests

3 participants