search

aidanjohnson / dt7816

Acoustic Array for Tracking Coordinated Flight of Foraging Bats
GNU General Public License v3.0
0 stars 0 forks source link

Testing workflow #5

Closed leewujung closed 6 years ago

leewujung commented 6 years ago
aidanjohnson commented 6 years ago

@funnyabc: What is meant by workflow is the written procedures for pull requests and merging. That is, we should have only one person to go through and merge (me) commits in pull requests from contributors (you). Putting it all in writing limits conflict.

Resources

UPDATE (2018-07-18 17h30): @funnyabc see this link for creating a issue template. See also these pages on templates:

funnyabc commented 6 years ago

Here is the proposed workflow that I see would work out for this project.

Everyone will be on the master branch, but every time there is a new feature being added, it needs to be in a separate branch.

Each branch must be synched up with the master repository, so as to not cause many conflicts when developing and submitting pull requests. When a feature is ready to be added, the user must submit a pull request with the master branch and someone (currently designating Aidan) needs to verify the feature will be compatible. There will be a template that will be used to submit each request, which will be made by the end of the week.

leewujung commented 6 years ago

These sound good. Looking forward to the template!

aidanjohnson commented 6 years ago

@funnyabc Here's the link for the issue, pull request, and contribution templates: https://github.com/aidanjohnson/dt7816/community

funnyabc commented 6 years ago

These are some templates I am using from Steve Mao, another GitHub user who created these. The templates are from the public domain and available to use by the general public.

The template is a question and answer style, with a description for each portion of the template. In addition, there is a section that describes tests that need to be conducted by the contributor that shows the feature works in the context of the entire project.

https://github.com/aidanjohnson/dt7816/tree/master/.github

Template source repo: https://github.com/stevemao/github-issue-templates/tree/master/questions-answers

funnyabc commented 6 years ago

The basic workflow will be defined as the following steps.

  1. Create a new branch. (Ensure to keep this branch updated with master during the entire development process)

  2. Develop the feature

  3. Test the feature until all cases covered and can confirm that it does not adversely affect any other project featured

  4. Submit issue stating change. Then submit pull request with that feature. (If any changes need to be made according to the verifier, make them and resubmit). Be sure to fill out the issue and pull request templates when doing so.

aidanjohnson commented 6 years ago

~Added the complete objectives in the wiki at: https://github.com/aidanjohnson/dt7816/wiki/Contributing~

UPDATE (2018-08-01 15h00): https://github.com/aidanjohnson/dt7816/tree/master/.github contains all the guidelines and templates. While the issues template is not recognised in the 'Insights/Community' menu, it does work when creating a new issue.