├── CONTRIBUTING.md ├── CONTRIBUTORS ├── LICENSE └── README.md /CONTRIBUTING.md: -------------------------------------------------------------------------------- 1 | # Contributing to CoreStore 2 | 3 | The following is a initial idea how it can look like when it grows. 4 | 5 | But for now all ways to post feedback/code are welcome. If you send code please see 6 | section **Developer Certificate of Origin**. 7 | 8 | ------- 9 | 10 | Courtesy of [Docker CONTRIBUTING.md](https://github.com/docker/docker/blob/master/CONTRIBUTING.md) 11 | 12 | @todo integrate the idea of: [http://symfony.com/doc/current/contributing/code/core_team.html](http://symfony.com/doc/current/contributing/code/core_team.html) 13 | or of [https://github.com/docker/docker/blob/master/MAINTAINERS](https://github.com/docker/docker/blob/master/MAINTAINERS) 14 | 15 | Want to hack on CoreStore? Awesome! 16 | 17 | Here are instructions to get you started. They are probably not perfect, 18 | please let us know if anything feels wrong or incomplete. 19 | 20 | ## Topics 21 | 22 | * [Reporting Security Issues](#reporting-security-issues) 23 | * [Reporting Issues](#reporting-issues) 24 | * [Build Environment](#build-environment) 25 | * [Contribution Guidelines](#contribution-guidelines) 26 | * [Community Guidelines](#corestore-community-guidelines) 27 | 28 | ## Reporting Security Issues 29 | 30 | The CoreStore maintainers take security very seriously. If you discover a security issue, 31 | please bring it to their attention right away! 32 | 33 | Please send your report privately to [security@corestore.io](mailto:security@corestore.io), 34 | please **DO NOT** file a public issue. 35 | 36 | Security reports are greatly appreciated and we will publicly thank you for it. 37 | We currently do not offer a paid security bounty program, but are not ruling it out in 38 | the future. 39 | 40 | ## Reporting Issues 41 | 42 | A great way to contribute to the project is to send a detailed report when you 43 | encounter an issue. We always appreciate a well-written, thorough bug report, 44 | and will thank you for it! 45 | 46 | When reporting [issues](https://github.com/corestoreio/corestore/issues) on 47 | GitHub please include your host OS, Go version, CoreStore version, version of the Magento 48 | database ... 49 | 50 | Please also include the steps required to reproduce the problem if 51 | possible and applicable. This information will help us review and fix 52 | your issue faster. 53 | 54 | ## Build Environment 55 | 56 | For instructions on setting up your development environment, please 57 | see our dedicated *dev environment setup docs*. 58 | 59 | ## Contribution guidelines 60 | 61 | ### Pull requests are always welcome 62 | 63 | We are always thrilled to receive pull requests, and do our best to 64 | process them as quickly as possible. Not sure if that typo is worth a pull 65 | request? Do it! We will appreciate it. 66 | 67 | If your pull request is not accepted on the first try, don't be 68 | discouraged! If there's a problem with the implementation, hopefully you 69 | received feedback on what to improve. 70 | 71 | We're trying very hard to keep CoreStore lean and focused. We don't want it 72 | to do everything for everybody. This means that we might decide against 73 | incorporating a new feature. However, there might be a way to implement 74 | that feature *on top of* CoreStore. 75 | 76 | ### Discuss your design on the mailing list 77 | 78 | We recommend discussing your plans [discuss.corestore.io](https://discuss.corestore.io) 79 | before starting to code - especially for more ambitious contributions. 80 | This gives other contributors a chance to point you in the right 81 | direction, give feedback on your design, and maybe point out if someone 82 | else is working on the same thing. 83 | 84 | ### Create issues... 85 | 86 | Any significant improvement should be documented as [a GitHub 87 | issue](https://github.com/corestoreio/corestore/issues) before anybody 88 | starts working on it. 89 | 90 | ### ...but check for existing issues first! 91 | 92 | Please take a moment to check that an issue doesn't already exist 93 | documenting your bug report or improvement proposal. If it does, it 94 | never hurts to add a quick "+1" or "I have this problem too". This will 95 | help prioritize the most common problems and requests. 96 | 97 | ### Conventions 98 | 99 | Fork the repository and make changes on your fork in a feature branch: 100 | 101 | - If it's a bug fix branch, name it XXXX-something where XXXX is the number of the 102 | issue. 103 | - If it's a feature branch, create an enhancement issue to announce your 104 | intentions, and name it XXXX-something where XXXX is the number of the issue. 105 | 106 | Submit unit tests for your changes. Go has a great test framework built in; use 107 | it! Take a look at existing tests for inspiration. Run the full test suite on 108 | your branch before submitting a pull request. 109 | 110 | Update the documentation when creating or modifying features. Test 111 | your documentation changes for clarity, concision, and correctness, as 112 | well as a clean documentation build. See `docs/README.md` for more 113 | information on building the docs and how they get released. 114 | 115 | Write clean code. Universally formatted code promotes ease of writing, reading, 116 | and maintenance. Always run `gofmt -s -w file.go` on each changed file before 117 | committing your changes. Most editors have plug-ins that do this automatically. 118 | 119 | Pull requests descriptions should be as clear as possible and include a 120 | reference to all the issues that they address. 121 | 122 | Commit messages must start with a capitalized and short summary (max. 50 123 | chars) written in the imperative, followed by an optional, more detailed 124 | explanatory text which is separated from the summary by an empty line. 125 | 126 | Code review comments may be added to your pull request. Discuss, then make the 127 | suggested modifications and push additional commits to your feature branch. Be 128 | sure to post a comment after pushing. The new commits will show up in the pull 129 | request automatically, but the reviewers will not be notified unless you 130 | comment. 131 | 132 | Pull requests must be cleanly rebased ontop of master without multiple branches 133 | mixed into the PR. 134 | 135 | **Git tip**: If your PR no longer merges cleanly, use `rebase master` in your 136 | feature branch to update your pull request rather than `merge master`. 137 | 138 | Before the pull request is merged, make sure that you squash your commits into 139 | logical units of work using `git rebase -i` and `git push -f`. After every 140 | commit the test suite should be passing. Include documentation changes in the 141 | same commit so that a revert would remove all traces of the feature or fix. 142 | 143 | Commits that fix or close an issue should include a reference like 144 | `Closes #XXXX` or `Fixes #XXXX`, which will automatically close the 145 | issue when merged. 146 | 147 | Please do not add yourself to the `AUTHORS` file, as it is regenerated 148 | regularly from the Git history. 149 | 150 | ### Merge approval 151 | 152 | CoreStore maintainers use LGTM (Looks Good To Me) in comments on the code review 153 | to indicate acceptance. 154 | 155 | A change requires LGTMs from an absolute majority of the maintainers of each 156 | component affected. 157 | 158 | For more details see [MAINTAINERS](MAINTAINERS) 159 | 160 | ### Sign your work 161 | 162 | The sign-off is a simple line at the end of the explanation for the 163 | patch, which certifies that you wrote it or otherwise have the right to 164 | pass it on as an open-source patch. The rules are pretty simple: if you 165 | can certify the below (from 166 | [developercertificate.org](http://developercertificate.org/)): 167 | 168 | ``` 169 | Developer Certificate of Origin 170 | Version 1.1 171 | 172 | Copyright (C) 2004, 2006 The Linux Foundation and its contributors. 173 | 660 York Street, Suite 102, 174 | San Francisco, CA 94110 USA 175 | 176 | Everyone is permitted to copy and distribute verbatim copies of this 177 | license document, but changing it is not allowed. 178 | 179 | Developer's Certificate of Origin 1.1 180 | 181 | By making a contribution to this project, I certify that: 182 | 183 | (a) The contribution was created in whole or in part by me and I 184 | have the right to submit it under the open source license 185 | indicated in the file; or 186 | 187 | (b) The contribution is based upon previous work that, to the best 188 | of my knowledge, is covered under an appropriate open source 189 | license and I have the right under that license to submit that 190 | work with modifications, whether created in whole or in part 191 | by me, under the same open source license (unless I am 192 | permitted to submit under a different license), as indicated 193 | in the file; or 194 | 195 | (c) The contribution was provided directly to me by some other 196 | person who certified (a), (b) or (c) and I have not modified 197 | it. 198 | 199 | (d) I understand and agree that this project and the contribution 200 | are public and that a record of the contribution (including all 201 | personal information I submit with it, including my sign-off) is 202 | maintained indefinitely and may be redistributed consistent with 203 | this project or the open source license(s) involved. 204 | ``` 205 | 206 | Then you just add a line to every git commit message: 207 | 208 | Signed-off-by: John Doe 209 | 210 | Using your real name (sorry, no pseudonyms or anonymous contributions.) 211 | 212 | If you set your `user.name` and `user.email` git configs, you can sign your 213 | commit automatically with `git commit -s`. 214 | 215 | ### How can I become a maintainer? 216 | 217 | * Step 1: Learn the component inside out 218 | * Step 2: Make yourself useful by contributing code, bug fixes, support etc. 219 | * Step 3: Volunteer on the IRC channel (#corestore at Freenode) 220 | * Step 4: Propose yourself at a scheduled corestore meeting in #corestore-dev 221 | 222 | Don't forget: being a maintainer is a time investment. Make sure you 223 | will have time to make yourself available. You don't have to be a 224 | maintainer to make a difference on the project! 225 | 226 | ### IRC Meetings 227 | 228 | There are two monthly meetings taking place on #corestore-dev IRC to accomodate all timezones. 229 | Anybody can ask for a topic to be discussed prior to the meeting. 230 | 231 | If you feel the conversation is going off-topic, feel free to point it out. 232 | 233 | For the exact dates and times, have a look at [the irc-minutes repo](https://github.com/corestore/irc-minutes). 234 | They also contain all the notes from previous meetings. 235 | 236 | ## CoreStore Community Guidelines 237 | 238 | We want to keep the CoreStore community awesome, growing and collaborative. We 239 | need your help to keep it that way. To help with this we've come up with some 240 | general guidelines for the community as a whole: 241 | 242 | * Be nice: Be courteous, respectful and polite to fellow community members: no 243 | regional, racial, gender, or other abuse will be tolerated. We like nice people 244 | way better than mean ones! 245 | 246 | * Encourage diversity and participation: Make everyone in our community 247 | feel welcome, regardless of their background and the extent of their 248 | contributions, and do everything possible to encourage participation in 249 | our community. 250 | 251 | * Keep it legal: Basically, don't get us in trouble. Share only content that 252 | you own, do not share private or sensitive information, and don't break the 253 | law. 254 | 255 | * Stay on topic: Make sure that you are posting to the correct channel 256 | and avoid off-topic discussions. Remember when you update an issue or 257 | respond to an email you are potentially sending to a large number of 258 | people. Please consider this before you update. Also remember that 259 | nobody likes spam. 260 | 261 | ### Guideline Violations — 3 Strikes Method 262 | 263 | The point of this section is not to find opportunities to punish people, but we 264 | do need a fair way to deal with people who are making our community suck. 265 | 266 | 1. First occurrence: We'll give you a friendly, but public reminder that the 267 | behavior is inappropriate according to our guidelines. 268 | 269 | 2. Second occurrence: We will send you a private message with a warning that 270 | any additional violations will result in removal from the community. 271 | 272 | 3. Third occurrence: Depending on the violation, we may need to delete or ban 273 | your account. 274 | 275 | **Notes:** 276 | 277 | * Obvious spammers are banned on first occurrence. If we don't do this, we'll 278 | have spam all over the place. 279 | 280 | * Violations are forgiven after 6 months of good behavior, and we won't 281 | hold a grudge. 282 | 283 | * People who commit minor infractions will get some education, 284 | rather than hammering them in the 3 strikes process. 285 | 286 | * The rules apply equally to everyone in the community, no matter how 287 | much you've contributed. 288 | 289 | * Extreme violations of a threatening, abusive, destructive or illegal nature 290 | will be addressed immediately and are not subject to 3 strikes or 291 | forgiveness. 292 | 293 | * Contact abuse@corestore.io to report abuse or appeal violations. In the case of 294 | appeals, we know that mistakes happen, and we'll work with you to come up with 295 | a fair solution if there has been a misunderstanding. 296 | -------------------------------------------------------------------------------- /CONTRIBUTORS: -------------------------------------------------------------------------------- 1 | Review https://github.com/docker/docker/blob/master/MAINTAINERS 2 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | 2 | Apache License 3 | Version 2.0, January 2004 4 | http://www.apache.org/licenses/ 5 | 6 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 7 | 8 | 1. Definitions. 9 | 10 | "License" shall mean the terms and conditions for use, reproduction, 11 | and distribution as defined by Sections 1 through 9 of this document. 12 | 13 | "Licensor" shall mean the copyright owner or entity authorized by 14 | the copyright owner that is granting the License. 15 | 16 | "Legal Entity" shall mean the union of the acting entity and all 17 | other entities that control, are controlled by, or are under common 18 | control with that entity. For the purposes of this definition, 19 | "control" means (i) the power, direct or indirect, to cause the 20 | direction or management of such entity, whether by contract or 21 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 22 | outstanding shares, or (iii) beneficial ownership of such entity. 23 | 24 | "You" (or "Your") shall mean an individual or Legal Entity 25 | exercising permissions granted by this License. 26 | 27 | "Source" form shall mean the preferred form for making modifications, 28 | including but not limited to software source code, documentation 29 | source, and configuration files. 30 | 31 | "Object" form shall mean any form resulting from mechanical 32 | transformation or translation of a Source form, including but 33 | not limited to compiled object code, generated documentation, 34 | and conversions to other media types. 35 | 36 | "Work" shall mean the work of authorship, whether in Source or 37 | Object form, made available under the License, as indicated by a 38 | copyright notice that is included in or attached to the work 39 | (an example is provided in the Appendix below). 40 | 41 | "Derivative Works" shall mean any work, whether in Source or Object 42 | form, that is based on (or derived from) the Work and for which the 43 | editorial revisions, annotations, elaborations, or other modifications 44 | represent, as a whole, an original work of authorship. For the purposes 45 | of this License, Derivative Works shall not include works that remain 46 | separable from, or merely link (or bind by name) to the interfaces of, 47 | the Work and Derivative Works thereof. 48 | 49 | "Contribution" shall mean any work of authorship, including 50 | the original version of the Work and any modifications or additions 51 | to that Work or Derivative Works thereof, that is intentionally 52 | submitted to Licensor for inclusion in the Work by the copyright owner 53 | or by an individual or Legal Entity authorized to submit on behalf of 54 | the copyright owner. For the purposes of this definition, "submitted" 55 | means any form of electronic, verbal, or written communication sent 56 | to the Licensor or its representatives, including but not limited to 57 | communication on electronic mailing lists, source code control systems, 58 | and issue tracking systems that are managed by, or on behalf of, the 59 | Licensor for the purpose of discussing and improving the Work, but 60 | excluding communication that is conspicuously marked or otherwise 61 | designated in writing by the copyright owner as "Not a Contribution." 62 | 63 | "Contributor" shall mean Licensor and any individual or Legal Entity 64 | on behalf of whom a Contribution has been received by Licensor and 65 | subsequently incorporated within the Work. 66 | 67 | 2. Grant of Copyright License. Subject to the terms and conditions of 68 | this License, each Contributor hereby grants to You a perpetual, 69 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 70 | copyright license to reproduce, prepare Derivative Works of, 71 | publicly display, publicly perform, sublicense, and distribute the 72 | Work and such Derivative Works in Source or Object form. 73 | 74 | 3. Grant of Patent License. Subject to the terms and conditions of 75 | this License, each Contributor hereby grants to You a perpetual, 76 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 77 | (except as stated in this section) patent license to make, have made, 78 | use, offer to sell, sell, import, and otherwise transfer the Work, 79 | where such license applies only to those patent claims licensable 80 | by such Contributor that are necessarily infringed by their 81 | Contribution(s) alone or by combination of their Contribution(s) 82 | with the Work to which such Contribution(s) was submitted. If You 83 | institute patent litigation against any entity (including a 84 | cross-claim or counterclaim in a lawsuit) alleging that the Work 85 | or a Contribution incorporated within the Work constitutes direct 86 | or contributory patent infringement, then any patent licenses 87 | granted to You under this License for that Work shall terminate 88 | as of the date such litigation is filed. 89 | 90 | 4. Redistribution. You may reproduce and distribute copies of the 91 | Work or Derivative Works thereof in any medium, with or without 92 | modifications, and in Source or Object form, provided that You 93 | meet the following conditions: 94 | 95 | (a) You must give any other recipients of the Work or 96 | Derivative Works a copy of this License; and 97 | 98 | (b) You must cause any modified files to carry prominent notices 99 | stating that You changed the files; and 100 | 101 | (c) You must retain, in the Source form of any Derivative Works 102 | that You distribute, all copyright, patent, trademark, and 103 | attribution notices from the Source form of the Work, 104 | excluding those notices that do not pertain to any part of 105 | the Derivative Works; and 106 | 107 | (d) If the Work includes a "NOTICE" text file as part of its 108 | distribution, then any Derivative Works that You distribute must 109 | include a readable copy of the attribution notices contained 110 | within such NOTICE file, excluding those notices that do not 111 | pertain to any part of the Derivative Works, in at least one 112 | of the following places: within a NOTICE text file distributed 113 | as part of the Derivative Works; within the Source form or 114 | documentation, if provided along with the Derivative Works; or, 115 | within a display generated by the Derivative Works, if and 116 | wherever such third-party notices normally appear. The contents 117 | of the NOTICE file are for informational purposes only and 118 | do not modify the License. You may add Your own attribution 119 | notices within Derivative Works that You distribute, alongside 120 | or as an addendum to the NOTICE text from the Work, provided 121 | that such additional attribution notices cannot be construed 122 | as modifying the License. 123 | 124 | You may add Your own copyright statement to Your modifications and 125 | may provide additional or different license terms and conditions 126 | for use, reproduction, or distribution of Your modifications, or 127 | for any such Derivative Works as a whole, provided Your use, 128 | reproduction, and distribution of the Work otherwise complies with 129 | the conditions stated in this License. 130 | 131 | 5. Submission of Contributions. Unless You explicitly state otherwise, 132 | any Contribution intentionally submitted for inclusion in the Work 133 | by You to the Licensor shall be under the terms and conditions of 134 | this License, without any additional terms or conditions. 135 | Notwithstanding the above, nothing herein shall supersede or modify 136 | the terms of any separate license agreement you may have executed 137 | with Licensor regarding such Contributions. 138 | 139 | 6. Trademarks. This License does not grant permission to use the trade 140 | names, trademarks, service marks, or product names of the Licensor, 141 | except as required for reasonable and customary use in describing the 142 | origin of the Work and reproducing the content of the NOTICE file. 143 | 144 | 7. Disclaimer of Warranty. Unless required by applicable law or 145 | agreed to in writing, Licensor provides the Work (and each 146 | Contributor provides its Contributions) on an "AS IS" BASIS, 147 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 148 | implied, including, without limitation, any warranties or conditions 149 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 150 | PARTICULAR PURPOSE. You are solely responsible for determining the 151 | appropriateness of using or redistributing the Work and assume any 152 | risks associated with Your exercise of permissions under this License. 153 | 154 | 8. Limitation of Liability. In no event and under no legal theory, 155 | whether in tort (including negligence), contract, or otherwise, 156 | unless required by applicable law (such as deliberate and grossly 157 | negligent acts) or agreed to in writing, shall any Contributor be 158 | liable to You for damages, including any direct, indirect, special, 159 | incidental, or consequential damages of any character arising as a 160 | result of this License or out of the use or inability to use the 161 | Work (including but not limited to damages for loss of goodwill, 162 | work stoppage, computer failure or malfunction, or any and all 163 | other commercial damages or losses), even if such Contributor 164 | has been advised of the possibility of such damages. 165 | 166 | 9. Accepting Warranty or Additional Liability. While redistributing 167 | the Work or Derivative Works thereof, You may choose to offer, 168 | and charge a fee for, acceptance of support, warranty, indemnity, 169 | or other liability obligations and/or rights consistent with this 170 | License. However, in accepting such obligations, You may act only 171 | on Your own behalf and on Your sole responsibility, not on behalf 172 | of any other Contributor, and only if You agree to indemnify, 173 | defend, and hold each Contributor harmless for any liability 174 | incurred by, or claims asserted against, such Contributor by reason 175 | of your accepting any such warranty or additional liability. 176 | 177 | END OF TERMS AND CONDITIONS 178 | 179 | Copyright 2013-2015 Docker, Inc. 180 | 181 | Licensed under the Apache License, Version 2.0 (the "License"); 182 | you may not use this file except in compliance with the License. 183 | You may obtain a copy of the License at 184 | 185 | http://www.apache.org/licenses/LICENSE-2.0 186 | 187 | Unless required by applicable law or agreed to in writing, software 188 | distributed under the License is distributed on an "AS IS" BASIS, 189 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 190 | See the License for the specific language governing permissions and 191 | limitations under the License. 192 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # CoreStore 2 | 3 | eCommerce library written in [GoLang](http://golang.org) based on Magento's database structure. 4 | 5 | Compatible to Magento 1 and 2. 6 | 7 | For more details: [http://corestore.io](http://corestore.io) 8 | 9 | Magento is a trademark of [MAGENTO, INC.](http://www.magentocommerce.com/license/). 10 | 11 | ## Contributing 12 | 13 | [![Join the chat at https://gitter.im/corestoreio/csfw](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/corestoreio/csfw?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) 14 | 15 | Please have a look at the [contribution guidelines](https://github.com/corestoreio/corestore/blob/master/CONTRIBUTING.md). 16 | 17 | ## Licensing 18 | 19 | CoreStore is licensed under the Apache License, Version 2.0. See 20 | [LICENSE](https://github.com/corestoreio/corestore/blob/master/LICENSE) for the full license text. 21 | 22 | ## Copyright 23 | 24 | [Cyrill Schumacher](http://cyrillschumacher.com) - [PGP Key](https://keybase.io/cyrill) 25 | --------------------------------------------------------------------------------