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.

Sign up for GitHub

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

Jump to bottom

Move Towards a GitFlow #24

Closed
kb1lqc opened this issue Jan 25, 2018 · 3 comments
Closed

Move Towards a GitFlow #24

kb1lqc opened this issue Jan 25, 2018 · 3 comments
Assignees
@kb1lqc
Labels
documentation
Milestone
Completed Initial...

Comments

@kb1lqc
Copy link
Member

kb1lqc commented Jan 25, 2018

Per the GitFlow documentation we should use a develop branch for our development code.

  • Create a develop branch
  • Document the intended workflow to be used for this project

Documentation is likely to be in a different repository since we should just keep the entire FaradayRF project base the same.
@kb1lqc kb1lqc added this to the Completed Initial Test Suite milestone Jan 25, 2018
@kb1lqc kb1lqc self-assigned this Jan 25, 2018
@kb1lqc kb1lqc changed the title Move towards a GitFlow Move Towards a GitFlow Jan 25, 2018
kb1lqc added a commit to kb1lqc/faradayio that referenced this issue Jan 25, 2018
@kb1lqc
Cleaned up unused dstaddr from TUN code
730b1b4 
* No need for a python-pytun `dstaddr` since it's not what we thought it
was. It's for point to point and we really don't want that. Per FaradayRF#21
* Added mtu parameter to Monitor class
* Updated all unit tests to pass with new dstaddr removal and mtu
addition.
* Added a `develop` branch per FaradayRF#24
@kb1lqc
Copy link
Member Author

kb1lqc commented Jan 26, 2018

Created a develop branch. Now I need to document this in a CONTRIBUTING.md or something.

@kb1lqc
Copy link
Member Author

kb1lqc commented Jan 26, 2018

I like the idea of using an organization wide contributing.md file. This is similar to how the atom project does it:

Notice how the other repositories that were not the main repo linked back to the main document. I see us having a CONTRIBUTING.md in our Athena repository. This could work well for all future projects and it could use our old document from faraday-software as a guide.

@kb1lqc
Copy link
Member Author

kb1lqc commented Jan 26, 2018

Fixed enough on this repository to close this ticket:

  • Added a CONTRIBUTIONS.md which simply links to our main document for the entire FaradayRF organization.
  • Added #1 to the Athena repository which includes a GitFlow task. This will describe how our repositories aim to work with the GitFlow method.

@kb1lqc kb1lqc closed this as completed Jan 26, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@kb1lqc kb1lqc

Labels
documentation
Projects
None yet
Milestone
Completed Initial Test Suite
Development

No branches or pull requests
1 participant
@kb1lqc