Skip to content
This repository was archived by the owner on Aug 1, 2023. It is now read-only.

Commit c637f7c

Browse files
committed
Update boilerplate
1 parent 306a3ac commit c637f7c

39 files changed

+95
-41
lines changed

CONTRIBUTING.md

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
# Contributing to hack-router-codegen
2+
We want to make contributing to this project as easy and transparent as
3+
possible.
4+
5+
## Our Development Process
6+
7+
All development is direclty on GitHub.
8+
9+
## Pull Requests
10+
We actively welcome your pull requests.
11+
12+
1. Fork the repo and create your branch from `master`.
13+
2. If you've added code that should be tested, add tests.
14+
3. If you've changed APIs, update the documentation.
15+
4. Ensure the test suite passes.
16+
5. Make sure your code lints.
17+
6. If you haven't already, complete the Contributor License Agreement ("CLA").
18+
19+
## Contributor License Agreement ("CLA")
20+
In order to accept your pull request, we need you to submit a CLA. You only need
21+
to do this once to work on any of Facebook's open source projects.
22+
23+
Complete your CLA here: <https://code.facebook.com/cla>
24+
25+
## Issues
26+
We use GitHub issues to track public bugs. Please ensure your description is
27+
clear and has sufficient instructions to be able to reproduce the issue.
28+
29+
Facebook has a [bounty program](https://www.facebook.com/whitehat/) for the safe
30+
disclosure of security bugs. In those cases, please go through the process
31+
outlined on that page and do not file a public issue.
32+
33+
## Coding Style
34+
35+
Coding should match `hh_format`/`hackfmt` where practical; the key parts are:
36+
37+
* 2 spaces for indentation rather than tabs
38+
* 80 character line length
39+
* indent, don't align
40+
41+
## License
42+
43+
By contributing to hack-router-codegen, you agree that your contributions will be licensed
44+
under the LICENSE file in the root directory of this source tree.

README.md

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ Hack-Router-Codegen [![Build Status](https://travis-ci.org/fredemmott/hack-route
22
===================
33

44
Code generation for controller classes using the `UriPattern` system from
5-
[`fredemmott/hack-router`](https://github.com/fredemmott/hack-router)
5+
[`hhvm/hack-router`](https://github.com/hhvm/hack-router)
66

77
This currently supports generating:
88
- Request routing maps
@@ -18,7 +18,7 @@ Building a Request Router
1818
<?hh
1919
require_once(__DIR__.'/../vendor/autoload.php');
2020
21-
use \FredEmmott\HackRouter\Codegen;
21+
use \Facebook\HackRouter\Codegen;
2222
2323
final class UpdateCodegen {
2424
public function main(): void {
@@ -43,8 +43,8 @@ automatically-generated route map, based on the URI patterns in your
4343
controllers.
4444

4545
`WebController` is the root controller for your site, and must implement
46-
`FredEmmott\HackRouter\IncludeInUriMap`, which in turn requires
47-
`FredEmmott\HackRouter\HasUriPattern` - for example:
46+
`Facebook\HackRouter\IncludeInUriMap`, which in turn requires
47+
`Facebook\HackRouter\HasUriPattern` - for example:
4848

4949
```Hack
5050
public static function getUriPattern(): UriPattern {
@@ -66,3 +66,13 @@ otherwise have a circular dependency:
6666
- HHVM will not execute hack code if there are references to undefined classes
6767
- Once you use the codegen, you reference the codegen classes
6868
- ... so you can't build them if you don't already have them
69+
70+
Contributing
71+
============
72+
73+
We welcome GitHub issues and pull requests - please see CONTRIBUTING.md for details.
74+
75+
License
76+
=======
77+
78+
hack-router-codegen is BSD-licensed. We also provide an additional patent grant.

src/Codegen.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<?hh // strict
22
/*
3-
* Copyright (c) 2016, Facebook, Inc.
3+
* Copyright (c) 2016-present, Facebook, Inc.
44
* All rights reserved.
55
*
66
* This source code is licensed under the BSD-style license found in the

src/RequestParametersCodegenBuilder.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<?hh // strict
22
/*
3-
* Copyright (c) 2016, Facebook, Inc.
3+
* Copyright (c) 2016-present, Facebook, Inc.
44
* All rights reserved.
55
*
66
* This source code is licensed under the BSD-style license found in the

src/RequestParametersCodegenBuilderBase.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<?hh // strict
22
/*
3-
* Copyright (c) 2016, Facebook, Inc.
3+
* Copyright (c) 2016-present, Facebook, Inc.
44
* All rights reserved.
55
*
66
* This source code is licensed under the BSD-style license found in the

src/RouterCodegenBuilder.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<?hh // strict
22
/*
3-
* Copyright (c) 2016, Facebook, Inc.
3+
* Copyright (c) 2016-present, Facebook, Inc.
44
* All rights reserved.
55
*
66
* This source code is licensed under the BSD-style license found in the

src/UriBuilderCodegenBuilder.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<?hh // strict
22
/*
3-
* Copyright (c) 2016, Facebook, Inc.
3+
* Copyright (c) 2016-present, Facebook, Inc.
44
* All rights reserved.
55
*
66
* This source code is licensed under the BSD-style license found in the

src/UriMapBuilder.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<?hh // strict
22
/*
3-
* Copyright (c) 2016, Facebook, Inc.
3+
* Copyright (c) 2016-present, Facebook, Inc.
44
* All rights reserved.
55
*
66
* This source code is licensed under the BSD-style license found in the

src/interfaces/IncludeInUriMap.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<?hh // strict
22
/*
3-
* Copyright (c) 2016, Facebook, Inc.
3+
* Copyright (c) 2016-present, Facebook, Inc.
44
* All rights reserved.
55
*
66
* This source code is licensed under the BSD-style license found in the

src/interfaces/SupportsGetRequests.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<?hh // strict
22
/*
3-
* Copyright (c) 2016, Facebook, Inc.
3+
* Copyright (c) 2016-present, Facebook, Inc.
44
* All rights reserved.
55
*
66
* This source code is licensed under the BSD-style license found in the

0 commit comments

Comments
 (0)