Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix #23: separate modules for endpoints and framework #24

Merged
merged 1 commit into from
Aug 16, 2019

Conversation

adamchalmers
Copy link
Contributor

@adamchalmers adamchalmers commented Aug 8, 2019

I've reorganized the root of the repo. Previously there were two kinds of root modules: modules for particular Cloudflare endpoints (e.g. DNS or WorkersKV) and modules for the fundamental API framework (e.g. response, apiclient, auth).

This PR restructures the root of the crate so there are only two root modules: framework and endpoints.

Before:

src/
    account.rs
    apiclient.rs
    auth.rs
    dns.rs
    lib.rs
    mock.rs
    plan.rs
    response/
    workerskv/
    zone.rs

After:

src/
    endpoints/
        account.rs
        dns.rs
        plan.rs
        workerskv/
        zone.rs
    framework/
        apiclient.rs
        auth.rs
        mod.rs
        mock.rs
        response/

This will make it much more clear for contributors where their code should go. Are you adding a new endpoint? endpoints module. Are you changing the underlying API framework? framework module.

I've already integrated these changes into a branch of tunnelmon, and it was very straightforward.

@sssilver
Copy link
Contributor

@ashleymichal has a PR up that adds even more taxonomy to this.

Copy link
Contributor

@ashleymichal ashleymichal left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i would like to include a CONTRIBUTING.md or similar like that introduced in #2 ; that could be a subsequent PR though.

@adamchalmers
Copy link
Contributor Author

Added a CONTRIBUTING.md!

@adamchalmers adamchalmers merged commit 54b21d4 into master Aug 16, 2019
@delete-merged-branch delete-merged-branch bot deleted the achalmers/23 branch August 16, 2019 02:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants