Contributing

Creating and working on Issues

Pull requests

Git workflow

Spool uses the feature branching git workflow.

All development for a specific task (feature, bug fix, etc.) is done its own branch. For example, if you wanted to add an API endpoint to Spool that would allow devices to query for the current price of pineapple futures. In git, you would create a new branch from the current dev branch (either on Github or locally) called “feat/pineapple-futures-endpoint.” All the work to implement this new endpoint would happen in this branch. When the endpoint is implemented and tested you push it to the Github repository and create a pull request to merge it into the current dev branch.

To work on a new piece of code:

1. Create a branch from dev called “feat/my-feature-name” or “fix/my-bug-name.” This is your “feature branch”
2. Do all development work for that feature or bug fix in this feature branch.
3. When you are done with your feature, push your changes to the feature branch to Github.
4. Create a pull request to merge your feature branch into the development branch.

Project organization