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 a DEVELOPING.md file to document the development process #812

Closed
stuartellis opened this issue Nov 5, 2016 · 4 comments
Closed

Add a DEVELOPING.md file to document the development process #812

stuartellis opened this issue Nov 5, 2016 · 4 comments

Comments

@stuartellis
Copy link
Contributor

GitHub automatically shows the contents of CONTRIBUTING.md to both bug reporters and potential contributors, so we should have a separate document to explain the development workflow.

Possible items to cover:

  • Setting up a development environment
  • Coding style (see Use a Ruby style guide #805)
  • Branching and git workflow for this project
  • How to test changes locally
@tombruijn
Copy link
Member

Got my vote :)

We might need to go in depth in how to set up a Ruby environment and such or maybe recommend a docker container for development purposes (although that means setting up docker, replacing one setup with another). The "problem" is that there are also quite a few non-ruby developers using backup as their backup tool, and a guide to help them setup a dev environment would be very helpful.

I'm working on #805 in #814

The git branching process is quite simple right now. We merge everything on master and use feature branches and PRs to merge changes. But we might want to follow semver better than we do now by incorporating it in our branch setup. and use master for patch releases and develop for minor/major releases.

@stuartellis
Copy link
Contributor Author

I'm currently thinking that I'd like to get something in place for #807, and then come back to this.

If you don't already know Ruby then setting up a Ruby development environment is probably challenging, since the tools are scattered (chruby/rbenv/rvm, Bundler, RubyGems, plus native dependencies). Once we use containers for testing, then I'd be interested in seeing if we can get a usable (and probably optional) container-ized development environment.

@tombruijn
Copy link
Member

I'm currently thinking that I'd like to get something in place for #807

Okay 👍

@tombruijn tombruijn added this to the Next version milestone Dec 27, 2016
@tombruijn tombruijn removed their assignment Jul 19, 2017
@stale
Copy link

stale bot commented Nov 24, 2020

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

@stale stale bot added the stale label Nov 24, 2020
@stale stale bot closed this as completed Dec 9, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants