@@ -10,7 +10,7 @@ the [Proto.Actor gitter chat](https://gitter.im/asynkron/gam).
1010Depending on which version (or sometimes module) you want to work on, you should target a specific branch as explained
1111below:
1212
13- * ` dev ` – active development branch of Proto.Actor beta.
13+ - ` dev ` – active development branch of Proto.Actor beta.
1414
1515## Tags
1616
@@ -19,20 +19,20 @@ Proto.Actor uses tags to categorise issues into groups or mark their phase in de
1919Most notably many tags start with a ` t: ` prefix (as in ` topic: ` ), which categorises issues in terms of which module they
2020relate to. Examples are:
2121
22- - [ t: actor ] ( https://github.com/asynkron /protoactor-go/labels/t%3Aactor )
23- - [ t: remote ] ( https://github.com/asynkron /protoactor-go/labels/t%3Aremote )
24- - [ t: cluster ] ( https://github.com/asynkron /protoactor-go/labels/t%3Acluster )
25- - [ t: router ] ( https://github.com/asynkron /protoactor-go/labels/t%3Arouter )
26- - [ See all labels] ( https://github.com/asynkron /protoactor-go/labels )
22+ - [ t: actor ] ( https://github.com/keecon /protoactor-go/labels/t%3Aactor )
23+ - [ t: remote ] ( https://github.com/keecon /protoactor-go/labels/t%3Aremote )
24+ - [ t: cluster ] ( https://github.com/keecon /protoactor-go/labels/t%3Acluster )
25+ - [ t: router ] ( https://github.com/keecon /protoactor-go/labels/t%3Arouter )
26+ - [ See all labels] ( https://github.com/keecon /protoactor-go/labels )
2727
28- In general * all issues are open for anyone working on them * , however if you're new to the project and looking for an
28+ In general _ all issues are open for anyone working on them _ , however if you're new to the project and looking for an
2929issue
3030that will be accepted and likely is a nice one to get started you should check out the following tags:
3131
32- - [ community] ( https://github.com/asynkron /protoactor-go/labels/community ) - which identifies issues that the core team
32+ - [ community] ( https://github.com/keecon /protoactor-go/labels/community ) - which identifies issues that the core team
3333 will likely not have time to work on, or the issue is a nice entry level ticket. If you're not sure how to solve a
3434 ticket but would like to work on it feel free to ask in the issue about clarification or tips.
35- - [ nice-to-have (low-priority)] ( https://github.com/asynkron /protoactor-go/labels/nice-to-have ) - are tasks which make
35+ - [ nice-to-have (low-priority)] ( https://github.com/keecon /protoactor-go/labels/nice-to-have ) - are tasks which make
3636 sense, however are not very high priority (in case of other very high priority issues). If you see something
3737 interesting in this list, a contribution would be really wonderful!
3838
@@ -54,15 +54,15 @@ issue is:
5454
5555The last group of special tags indicate specific states a ticket is in:
5656
57- - [ bug] ( https://github.com/asynkron /protoactor-go/labels/bug ) - bugs take priority in being fixed above features. The
57+ - [ bug] ( https://github.com/keecon /protoactor-go/labels/bug ) - bugs take priority in being fixed above features. The
5858 core team dedicates a number of days to working on bugs each sprint. Bugs which have reproducers are also great for
5959 community contributions as they're well isolated. Sometimes we're not as lucky to have reproducers though, then a
6060 bugfix should also include a test reproducing the original error along with the fix.
6161
6262# Proto.Actor contributing guidelines
6363
64- These guidelines apply to all Proto.Actor projects, by which we mean both the ` asynkron /protoactor-go` repository,
65- as well as any plugins or additional repositories located under the asynkron/protoactor* .
64+ These guidelines apply to all Proto.Actor projects, by which we mean both the ` keecon /protoactor-go` repository,
65+ as well as any plugins or additional repositories located under the asynkron/protoactor\ * .
6666
6767These guidelines are meant to be a living document that should be changed and adapted as needed.
6868We encourage changes that make it easier to achieve our goals in an efficient way.
@@ -72,17 +72,17 @@ We encourage changes that make it easier to achieve our goals in an efficient wa
7272The steps below describe how to get a patch into a main development branch (e.g. ` dev ` ).
7373The steps are exactly the same for everyone involved in the project (be it core team, or first time contributor).
7474
75- 1 . Make sure an issue exists in the [ issue tracker] ( https://github.com/asynkron /protoactor-go/issues ) for the work you
75+ 1 . Make sure an issue exists in the [ issue tracker] ( https://github.com/keecon /protoactor-go/issues ) for the work you
7676 want to contribute.
77- - If there is no ticket for it, [ create one] ( https://github.com/asynkron /protoactor-go/issues/new ) first.
78- 1 . [ Fork the project] ( https://github.com/asynkron /protoactor-go#fork-destination-box ) on GitHub. You'll need to create a
77+ - If there is no ticket for it, [ create one] ( https://github.com/keecon /protoactor-go/issues/new ) first.
78+ 1 . [ Fork the project] ( https://github.com/keecon /protoactor-go#fork-destination-box ) on GitHub. You'll need to create a
7979 feature-branch for your work on your fork, as this way you'll be able to submit a pull request against the mainline
8080 Proto.Actor.
81811 . Create a branch on your fork and work on the feature. For
8282 example: ` git checkout -b wip-custom-serialization-protoactor `
83- - Please make sure to follow the general quality guidelines (specified below) when developing your patch.
84- - Please write additional tests covering your feature and adjust existing ones if needed before submitting your pull
85- request.
83+ - Please make sure to follow the general quality guidelines (specified below) when developing your patch.
84+ - Please write additional tests covering your feature and adjust existing ones if needed before submitting your pull
85+ request.
86861 . Once your feature is complete, prepare the commit following
8787 our [ Creating Commits And Writing Commit Messages] ( #creating-commits-and-writing-commit-messages ) . For example, a
8888 good commit message would be: ` Adding compression support for Manifests #22222 ` (note the reference to the ticket it
@@ -92,21 +92,21 @@ The steps are exactly the same for everyone involved in the project (be it core
9292 is not a feature.
93931 . Now it's finally time to [ submit the pull request] ( https://help.github.com/articles/using-pull-requests ) !
94941 . If you have not already done so, you will be asked by our CLA bot
95- to [ sign the Asynkron CLA] ( https://cla-assistant.io/asynkron /protoactor-go ) online. CLA stands for Contributor
95+ to [ sign the Asynkron CLA] ( https://cla-assistant.io/keecon /protoactor-go ) online. CLA stands for Contributor
9696 License Agreement and is a way of protecting intellectual property disputes from harming the project.
97971 . Now both committers and interested people will review your code. This process is to ensure the code we merge is of
9898 the best possible quality, and that no silly mistakes slip though. You're expected to follow-up these comments by
9999 adding new commits to the same branch. The commit messages of those commits can be more lose, for
100100 example: ` Removed debugging using printline ` , as they all will be squashed into one commit before merging into the
101101 main branch.
102- - The community and team are really nice people, so don't be afraid to ask follow up questions if you didn't
103- understand some comment, or would like clarification on how to continue with a given feature. We're here to help,
104- so feel free to ask and discuss any kind of questions you might have during review!
102+ - The community and team are really nice people, so don't be afraid to ask follow up questions if you didn't
103+ understand some comment, or would like clarification on how to continue with a given feature. We're here to help,
104+ so feel free to ask and discuss any kind of questions you might have during review!
1051051 . After the review you should fix the issues as needed (pushing a new commit for new review etc.), iterating until the
106106 reviewers give their thumbs up–which is signalled usually by a comment saying ` LGTM ` , which means "Looks Good To Me".
107- - In general a PR is expected to get 2 LGTMs from the team before it is merged. If the PR is trivial, or under
108- special circumstances (such as most of the team being on vacation, a PR was very thoroughly reviewed/tested and
109- surely is correct) one LGTM may be fine as well.
107+ - In general a PR is expected to get 2 LGTMs from the team before it is merged. If the PR is trivial, or under
108+ special circumstances (such as most of the team being on vacation, a PR was very thoroughly reviewed/tested and
109+ surely is correct) one LGTM may be fine as well.
1101101 . Once everything is said and done, your pull request gets merged :tada : Your feature will be available with the next
111111 “earliest” release milestone (i.e. if back-ported so that it will be in release x.y.z, find the relevant milestone
112112 for that release). And of course you will be given credit for the fix in the release stats during the release's
@@ -131,26 +131,26 @@ For a pull request to be considered at all it has to meet these requirements:
1311311 . The commit messages must properly describe the changes, see further below.
1321321 . All Asynkron projects must include Asynkron copyright notices. Each project can choose between one of two approaches:
133133
134- 1 . All source files in the project must have a Asynkron copyright notice in the file header.
135- 1 . The Notices file for the project includes the Asynkron copyright notice and no other files contain copyright
136- notices. See http://www.apache.org/legal/src-headers.html for instructions for managing this approach for
137- copyrights.
134+ 1 . All source files in the project must have a Asynkron copyright notice in the file header.
135+ 1 . The Notices file for the project includes the Asynkron copyright notice and no other files contain copyright
136+ notices. See http://www.apache.org/legal/src-headers.html for instructions for managing this approach for
137+ copyrights.
138138
139139 Proto.Actor uses the first choice, having copyright notices in every file header.
140140
141141### Additional guidelines
142142
143143Some additional guidelines regarding source code are:
144144
145- - Files should start with a `` Copyright (C) 2017 Asynkron.se <http://www.asynkron.se> ` ` copyright header.
145+ - Files should start with a ` Copyright (C) 2017 Asynkron.se <http://www.asynkron.se> ` copyright header.
146146- Keep the code [ DRY] ( http://programmer.97things.oreilly.com/wiki/index.php/Don%27t_Repeat_Yourself ) .
147147- Apply the [ Boy Scout Rule] ( http://programmer.97things.oreilly.com/wiki/index.php/The_Boy_Scout_Rule ) whenever you have
148148 the chance to.
149149- Never delete or change existing copyright notices, just add additional info.
150- - Do not use `` @author ` ` tags since it does not
150+ - Do not use ` @author ` tags since it does not
151151 encourage [ Collective Code Ownership] ( http://www.extremeprogramming.org/rules/collective.html ) .
152- - Contributors , each project should make sure that the contributors gets the credit they deserve—in a text file or
153- page on the project website and in the release notes etc.
152+ - Contributors , each project should make sure that the contributors gets the credit they deserve—in a text file or
153+ page on the project website and in the release notes etc.
154154
155155If these requirements are not met then the code should ** not** be merged into dev or master, or even reviewed -
156156regardless of how good or important it is. No exceptions.
@@ -185,7 +185,7 @@ This must be ensured by manually verifying the license for all the dependencies
185185
186186Which licenses are compatible with Apache 2 are defined
187187in [ this doc] ( http://www.apache.org/legal/3party.html#category-a ) , where you can see that the licenses that are listed
188- under `` Category A `` are automatically compatible with Apache 2, while the ones listed under `` Category B ` ` need
188+ under ` Category A ` are automatically compatible with Apache 2, while the ones listed under ` Category B ` need
189189additional action:
190190
191191> Each license in this category requires some degree
@@ -220,8 +220,8 @@ Follow these guidelines when creating public commits and writing commit messages
220220
2212214 . You can request review by a specific team member for your commit (depending on the degree of automation we reach, the
222222 list may change over time):
223- * `` Review by @gituser ` ` - if you want to notify someone on the team. The others can, and are encouraged to
224- participate.
223+ - ` Review by @gituser ` - if you want to notify someone on the team. The others can, and are encouraged to
224+ participate.
225225
226226Example:
227227
@@ -239,5 +239,5 @@ Each project should be configured to use a continuous integration (CI) tool (i.e
239239
240240## Related links
241241
242- * [ Proto.Actor Contributor License Agreement] ( https://cla-assistant.io/asynkron /protoactor-go )
243- * [ Proto.Actor Issue Tracker] ( https://github.com/asynkron /protoactor-go/issues )
242+ - [ Proto.Actor Contributor License Agreement] ( https://cla-assistant.io/keecon /protoactor-go )
243+ - [ Proto.Actor Issue Tracker] ( https://github.com/keecon /protoactor-go/issues )
0 commit comments