Eclectic Media Git caffeine / 3c6af43
Added contribution guidelines Ariana Giroux 4 months ago
1 changed file(s) with 26 addition(s) and 0 deletion(s). Raw diff Collapse all Expand all
5858 =======
5959
6060 Under the MIT license, circa 2020 by Ariana Giroux (ariana.giroux@gmail.com)
61
62
63 CONTRIBUTION
64 ============
65
66 To submit a bug, include any relavent details in an email to ariana.giroux+caffeine@gmail.com
67
68 To submit a patch, we use a git native pull request workflow.
69
70 First, clone the repository: ::
71
72 git clone git://git.eclecticmedia.space/public/caffeine
73
74 Then, once you've made your changes, push your copy to a publicly accessible location (i.e GitLab): ::
75
76 git remote add upstream $(git remote get-url origin) # keep the master repository link as upstream
77 git remote set-url origin *YOUR REPO URL* # change origin to your public URL
78
79 git push origin
80
81 Once you are confident in your changes, submit a git native pull request to ariana.giroux+caffeine@gmail.com: ::
82
83 git request-pull origin upstream # outputs pull request text, copy this into your email.
84
85 Please ensure you include a short description of the changed you've made.
86 We use a git native forking workflow.