Merge branch 'master' of github.com:gitlabhq/gitlabhq
This commit is contained in:
Dmitriy Zaporozhets
commit
1a83fea711
2 changed files with 109 additions and 0 deletions
|
|
@ -2,6 +2,12 @@
|
||||||
|
|
||||||
This guide details how to use issues and pull requests to improve GitLab.
|
This guide details how to use issues and pull requests to improve GitLab.
|
||||||
|
|
||||||
|
- [Closing policy for issues and pull requests](#closing-policy-for-issues-and-pull-requests)
|
||||||
|
- [Issue tracker](#issue-tracker)
|
||||||
|
- [Pull requests](#pull-requests)
|
||||||
|
|
||||||
|
If you want to know how the GitLab team handles contributions have a look at [the GitLab contributing process](PROCESS.md).
|
||||||
|
|
||||||
## Closing policy for issues and pull requests
|
## Closing policy for issues and pull requests
|
||||||
|
|
||||||
GitLab is a popular open source project and the capacity to deal with issues and pull requests is limited. Out of respect for our volunteers, issues and pull requests not in line with the guidelines listed in this document may be closed without notice.
|
GitLab is a popular open source project and the capacity to deal with issues and pull requests is limited. Out of respect for our volunteers, issues and pull requests not in line with the guidelines listed in this document may be closed without notice.
|
||||||
|
|
|
||||||
103
PROCESS.md
Normal file
103
PROCESS.md
Normal file
|
|
@ -0,0 +1,103 @@
|
||||||
|
# GitLab Contributing Process
|
||||||
|
|
||||||
|
## Purpose of describing the contributing process
|
||||||
|
|
||||||
|
Below we describe the contributing process for two reasons. Contributors know what to expect from maintainers (initial, response within xx days, friendly treatment, etc). And maintainers know what to expect from contributors (use latest version, confirm the issue is addressed, friendly treatment, etc).
|
||||||
|
|
||||||
|
## How we handle issues
|
||||||
|
|
||||||
|
The priority should be mentioning people that can help and assigning workflow labels. Workflow labels are purposely not very detailed since that would be hard to keep updated as you would need to reevaluate them after every comment. We optionally use functional labels on demand when want to group related issues to get an overview (for example all issues related to RVM, to tackle them in one go) and to add details to the issue.
|
||||||
|
|
||||||
|
If an issue is complex and needs the attention of a specific person, assignment is a good option but assigning issues might discourage other people from contributing to that issue. We need all the contributions we can get so this should never be discouraged. Also, an assigned person might not have time for a few weeks, so others should feel free to takeover.
|
||||||
|
|
||||||
|
Priority (from high to low):
|
||||||
|
|
||||||
|
1. Mentioning people (very important)
|
||||||
|
2. Workflow labels
|
||||||
|
3. Functional labels (less important)
|
||||||
|
4. Assigning issues (optional)
|
||||||
|
|
||||||
|
## Workflow labels
|
||||||
|
|
||||||
|
- _Awaiting feedback_: Feedback pending from the reporter
|
||||||
|
- _Awaiting confirmation of fix_: The issue should already be solved in **master** (generally you can avoid this workflow item and just close the issue right away)
|
||||||
|
- _Attached PR_: There is a PR attached and the discussion should happen there
|
||||||
|
- We need to let issues stay in sync with the PR's. We can do this with a "Closing #XXXX" or "Fixes #XXXX" comment in the PR. We can't close the issue when there is a pull request because sometimes a PR is not good and we just close the PR, then the issue must stay.
|
||||||
|
- _Awaiting developer action/feedback_: Issue needs to be fixed or clarified by a developer
|
||||||
|
|
||||||
|
## Functional labels
|
||||||
|
|
||||||
|
These labels describe what development specialities are involved such as: PostgreSQL, UX, LDAP.
|
||||||
|
|
||||||
|
## Label colors
|
||||||
|
- Light orange `#fef2c0`: workflow labels for issue team members (awaiting feedback, awaiting confirmation of fix)
|
||||||
|
- Bright orange `#eb6420`: workflow labels for core team members (attached PR, awaiting developer action/feedback)
|
||||||
|
- Light blue `#82C5FF`: functional labels
|
||||||
|
- Green labels `#009800`: issues that can generally be ignored. For example, issues given the following labels normally can be closed immediately:
|
||||||
|
- Feature request (see copy & paste response: [Feature requests](#feature-requests))
|
||||||
|
- Support (see copy & paste response: [Support requests and configuration questions](#support-requests-and-configuration-questions)
|
||||||
|
|
||||||
|
## Common actions
|
||||||
|
|
||||||
|
### Issue team
|
||||||
|
- Looks for issues without workflow labels and triages issue
|
||||||
|
- Monitors pull requests
|
||||||
|
- Closes invalid issues and pull requests with a comment (duplicates, [feature requests](#feature-requests), [fixed in newer version](#issue-fixed-in-newer-version), [issue report for old version](#issue-report-for-old-version), not a problem in GitLab, etc.)
|
||||||
|
- Assigns appropriate [labels](#how-we-handle-issues)
|
||||||
|
- Asks for feedback from issue reporter/pull request initiator ([invalid issue reports](#improperly-formatted-issue), [format code](#code-format), etc.)
|
||||||
|
- Asks for feedback from the relevant developer(s) based on the [list of members and their specialities](http://gitlab.org/team/)
|
||||||
|
- Monitors all issues/pull requests for feedback (but especially ones commented on since automatically watching them):
|
||||||
|
- Assigns issues to developers if they indicate they are fixing it
|
||||||
|
- Assigns pull requests to developers if they indicate they will take care of merge
|
||||||
|
- Closes issues with no feedback from the reporter for two weeks
|
||||||
|
- Closes stale pull requests
|
||||||
|
|
||||||
|
### Development team
|
||||||
|
|
||||||
|
- Responds to issues and pull requests the issue team mentions them in
|
||||||
|
- Monitors for new issues in _Awaiting developer action/feedback_ with no developer activity (once a week)
|
||||||
|
- Monitors for new pull requests (at least once a week)
|
||||||
|
- Manages their work queue by looking at issues and pull requests assigned to them
|
||||||
|
- Close fixed issues (via commit messages or manually)
|
||||||
|
- Codes [new features](http://feedback.gitlab.com/forums/176466-general/filters/top)!
|
||||||
|
- Response guidelines
|
||||||
|
- Be kind to people trying to contribute. Be aware that people can be a non-native or a native English speaker, they might not understand thing or they might be very sensitive to how your word things. Use emoji to express your feelings (hearth, star, smile, etc.). Some good tips about giving feedback to pull requests is in the [Thoughtbot code review guide](https://github.com/thoughtbot/guides/tree/master/code-review).
|
||||||
|
|
||||||
|
## Copy & paste responses
|
||||||
|
|
||||||
|
### Improperly formatted issue
|
||||||
|
|
||||||
|
Thanks for the issue report. Please reformat your issue to conform to the issue tracker guidelines found in our \[contributing guidelines\]\(https://github.com/gitlabhq/gitlabhq/blob/master/CONTRIBUTING.md#issue-tracker-guidelines).
|
||||||
|
|
||||||
|
### Feature requests
|
||||||
|
|
||||||
|
Thanks for your interest in GitLab. We don't use the GitHub issue tracker for feature requests. Please use http://feedback.gitlab.com/ for this purpose or create a pull request implementing this feature. Have a look at the \[contribution guidelines\]\(https://github.com/gitlabhq/gitlabhq/blob/master/CONTRIBUTING.md) for more information.
|
||||||
|
|
||||||
|
### Issue report for old version
|
||||||
|
|
||||||
|
Thanks for the issue report but we only support issues for the latest stable version of GitLab. I'm closing this issue but if you still experience this problem in the latest stable version, please open a new issue (but also reference the old issue(s)). Make sure to also include the necessary debugging information conforming to the issue tracker guidelines found in our \[contributing guidelines\]\(https://github.com/gitlabhq/gitlabhq/blob/master/CONTRIBUTING.md#issue-tracker-guidelines).
|
||||||
|
|
||||||
|
### Support requests and configuration questions
|
||||||
|
|
||||||
|
Thanks for your interest in GitLab. We don't use the GitHub issue tracker for support requests and configuration questions. Please use the \[support forum\]\(https://groups.google.com/forum/#!forum/gitlabhq), \[Stack Overflow\]\(http://stackoverflow.com/questions/tagged/gitlab), the unofficial #gitlab IRC channel on Freenode or the http://www.gitlab.com paid services for this purpose. Have a look at the \[contribution guidelines\]\(https://github.com/gitlabhq/gitlabhq/blob/master/CONTRIBUTING.md) for more information.
|
||||||
|
|
||||||
|
### Code format
|
||||||
|
|
||||||
|
Please use ``` to format console output, logs, and code as it's very hard to read otherwise.
|
||||||
|
|
||||||
|
### Issue fixed in newer version
|
||||||
|
|
||||||
|
Thanks for the issue report. This issue has already been fixed in newer versions of GitLab. Due to the size of this project and our limited resources we are only able to support the latest stable release as outlined in our \[contributing guidelines\]\(https://github.com/gitlabhq/gitlabhq/blob/master/CONTRIBUTING.md#issue-tracker). In order to get this bug fix and enjoy many new features please \[upgrade\]\(http://blog.gitlab.org/). If you still experience issues at that time please open a new issue following our issue tracker guidelines found in the \[contributing guidelines\]\(https://github.com/gitlabhq/gitlabhq/blob/master/CONTRIBUTING.md#issue-tracker-guidelines).
|
||||||
|
|
||||||
|
### Improperly formatted pull request
|
||||||
|
|
||||||
|
Thanks for your interest in improving the GitLab codebase! Please update your pull request according to the \[contributing guidelines\]\(https://github.com/gitlabhq/gitlabhq/blob/master/CONTRIBUTING.md#pull-request-guidelines).
|
||||||
|
|
||||||
|
### Inactivity close of an issue
|
||||||
|
|
||||||
|
It's been at least 2 weeks (and a new release) since we heard from you. I'm closing this issue but if you still experience this problem, please open a new issue (but also reference the old issue(s)). Make sure to also include the necessary debugging information conforming to the issue tracker guidelines found in our \[contributing guidelines\]\(https://github.com/gitlabhq/gitlabhq/blob/master/CONTRIBUTING.md#issue-tracker-guidelines).
|
||||||
|
|
||||||
|
### Inactivity close of a pull request
|
||||||
|
|
||||||
|
This pull request has been closed because a request for more information has not been reacted to for more than 2 weeks. If you respond and conform to the pull request guidelines in our \[contributing guidelines\]\(https://github.com/gitlabhq/gitlabhq/blob/master/CONTRIBUTING.md#pull-requests) we will reopen this pull request.
|
||||||
|
|
||||||
Loading…
Reference in a new issue