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

add update instructions to getting started #44

Closed
balmas opened this issue Jun 30, 2020 · 2 comments
Closed

add update instructions to getting started #44

balmas opened this issue Jun 30, 2020 · 2 comments
Labels
documentation enhancement New feature or request

Comments

@balmas
Copy link
Collaborator

balmas commented Jun 30, 2020

requested by @nevenjovanovic:

one thing bothers me about the current treebank templates and their Git
workflow. What happens if I have forked the repo, adapted the
configuration and added my documents -- and then you make a change to the
upstream repository, and I want to update my forked one?

In other words, are we, after the fork, committed to the forked version,
and we have to do everything again if the upstream repository is updated?
And what would be the best workflow for this "do everything again"?

Maybe, for advanced users who want to keep up with your work on the upstream repository, another workflow could
be developed and described?

@zfletch zfletch added the enhancement New feature or request label Jun 30, 2020
@zfletch
Copy link
Member

zfletch commented Jun 30, 2020

The instructions in the README for updating are currently:

  • git pull source master
  • Fix merge conflicts
  • git push origin master

When we add update instructions to the getting started document, we should probably specify a set of commands that will keep the user's src/config.json but uses the source branch's version for everything else.

@balmas
Copy link
Collaborator Author

balmas commented Jun 30, 2020

agreed. I'm not sure myself of what those steps are ...

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants