Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
Team Blue
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Package registry
Container registry
Model registry
Operate
Environments
Terraform modules
Monitor
Incidents
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
CourseEval
Team Blue
Commits
e763a15a
Commit
e763a15a
authored
3 years ago
by
Peter Mangelsdorf
Browse files
Options
Downloads
Patches
Plain Diff
update contributing guidelines with more details
parent
e5675123
No related branches found
No related tags found
No related merge requests found
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
CONTRIBUTING.md
+32
-0
32 additions, 0 deletions
CONTRIBUTING.md
with
32 additions
and
0 deletions
CONTRIBUTING.md
+
32
−
0
View file @
e763a15a
...
...
@@ -16,6 +16,7 @@
-
[
Guests
](
#guests
)
-
[
Testing
](
#testing
)
-
[
Document Standards
](
#document-standards
)
-
[
Finding Issues
](
#finding-issues
)
-
[
Other
](
#other
)
## Introduction
...
...
@@ -191,6 +192,37 @@ Most of these are pretty dull, but if you want access to any of them let [Peter]
[
**Decisions**
](
../decisions/
)
are formal write-ups of particular rules or processes.
Given the narrow timeframe and scope of the project, these are going to be sparse and focus on just a few choices.
## Finding Issues
### Why Should You Spend Time Looking for Pre-Existing Issues?
-
External Team (e-valuation) will benefit from clarity of team action
-
Course Instructor will benefit from clarity of actions
-
EvaP Team benefits from more clear communication of intent and lack of ambiguous tasks
-
The Course Instructor and EvaP Volunteers benefit from more understandable processes
-
Team Members benefit from more refined work process
-
Team Members at risk of getting confused/bogged down in these steps
### Process
-
Using:
-
[
EvaP Minor Issues
](
https://github.com/e-valuation/EvaP/labels/%5BP%5D%20Minor
)
-
[
EvaP Easy Issues
](
https://github.com/e-valuation/EvaP/labels/%5BS%5D%20Easy
)
-
[
EvaP Small Issues
](
https://github.com/e-valuation/EvaP/labels/%5BS%5D%20Small
)
-
[
EvaP Very Small Issues
](
https://github.com/e-valuation/EvaP/labels/%5BS%5D%20Very%20small
)
-
From these find issues that can be resolved within remaining time (2 weeks)
-
See the
[
Step Template for Follow On Issues
](
#step-template-for-follow-on-issues
)
below for more details
### Step Template for Follow On Issues
1.
Find an Issue on GitHub
2.
Explore Issue Details
3.
Attempt to Recreate Issue in Code/Locate Source of Error
4.
If solution is apparent, create a notifying message on the issue on GitHub
5.
Create a mirror issue in this repo's issue tracker
6.
Make a new branch on the local GitLab mirror of EvaP and name it after the issue (like
`1663-prioritize-grading`
)
7.
Comment a link to your branch on the GitLab issue you opened and on the original GitHub issue
8.
Commit your changes and run tests to the local mirror
9.
Once satisfied, create a new
**Pull Request**
on the EvaP GitHub repo
10.
Update issues with details once submitted
## Other
If there is anything else not covered here, reach out to the team.
This document is young, and open to suggestions.
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment