Skip to content
This repository was archived by the owner on Feb 28, 2018. It is now read-only.
This repository was archived by the owner on Feb 28, 2018. It is now read-only.

Documentation should be merged into code repository #3

Open

Description

Please could this repository's contents be merged into a documentation subdirectory of the master branch of the Git repository containing the HTTPS Everywhere codebase, and this repository thereafter deleted?

Currently, the documentation is somewhat out of sync with the codebase, and has had much less attention. I suspect that at least some developers working on the codebase aren't even aware that the documentation repository exists. Keeping the two in the same repository might help alleviate this problem.

Thanks!

P.S. I've asked for the contents to be merged into a documentation subdirectory of the codebase's master, rather than into a documentation branch. This is because if a developer begins work on a fix or feature by branching from master, then their new fix/feature branch will contain the documentation directory, making it obvious and easy for the developer to update the documentation appropriately in that branch, and keeping the documentation update and the fix/feature in sync.

If the documentation were, instead, in its own branch, which I don't advocate, then the workflow for the developer would be more laborious. They would have to create two feature/fix branches: one from the master branch and one from the documentation branch. And then they would have to keep their code feature/fix branch and documentation feature/fix branch in sync. It would be almost as bad as the current unhappy situation of having the documentation and codebase in separate repositories.

Activity

  1. ghost changed the title [-]Documentation in separate repo to code[/-] [+]Documentation should be merged into code repository[/+] on May 27, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions