Skip to content
New issue

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

#

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

Already on GitHub? # to your account

docs: Added clear community contribution guidelines #504

Merged
merged 7 commits into from
Feb 4, 2022
+47 −6
Merged

docs: Added clear community contribution guidelines #504

Changes from 1 commit
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
a0bb976
updated contributing guidelines
AlmasB Jan 27, 2022
827326e
removed extra space
AlmasB Jan 27, 2022
27da7b7
fixed a typo
AlmasB Jan 27, 2022
69ad775
added valid PR titles
AlmasB Feb 1, 2022
8218943
clarified different workflows
AlmasB Feb 1, 2022
49638bb
added a note about tests
AlmasB Feb 1, 2022
bca2cb2
refine
AlmasB Feb 3, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
clarified different workflows
@AlmasB
AlmasB committed Feb 1, 2022
commit 821894342666f6471508e040fdb867433e68ca80
19 changes: 12 additions & 7 deletions CONTRIBUTING.md
View file
Original file line number Diff line number Diff line change
@@ -1,12 +1,11 @@
## How to Contribute to Scene Builder

Contribution of any form is welcome! Please see the list below on how you can contribute to the project.
Contribution of any form is welcome! Please see workflows below on how you can contribute to the project.

* Provide or suggest an implementation of an issue from [GitHub Issues](https://github.com/gluonhq/scenebuilder/issues).
* Proof read the [public documentation](https://github.com/gluonhq/scenebuilder/wiki) for errors, ambiguities and typos.
* Create an issue or suggest a feature backed up by a use case.
* Add missing tests.
* Quality-test early release builds.
## Feature Request Workflow

1. Open a [discussion](https://github.com/gluonhq/scenebuilder/discussions) to suggest a feature backed up by a use case.
2. A maintainer will confirm the feature is beneficial for Scene Builder and will convert the discussion into a feature-request issue.

## Contribution Workflow

@@ -15,7 +14,13 @@ Contribution of any form is welcome! Please see the list below on how you can co
3. A maintainer will confirm the issue is valid and can be assigned to you for a fix.
4. You produce a Pull Request following the Standards below.
5. Once you tick all check boxes on the Pull Request template, it will be reviewed by a maintainer or a community member.
6. Once the Pull Request has at least one approval, it will be ready for a merge.
6. Once the Pull Request is approved (`minor` requires at least 1, `major` requires at least 2), it will be ready for a merge.

## QA Test Workflow

1. Grab an [early release package](https://github.com/gluonhq/scenebuilder/releases/tag/early-access).
2. Test newly merged features since the latest stable version, paying attention to the functionality of existing features, OR proof read the [public documentation](https://github.com/gluonhq/scenebuilder/wiki) for errors, ambiguities and typos.
3. Report any bugs, odd behavior, or inconsistencies to the maintainers as appropriate.

## Coding Standards