CONTRIBUTING.md

In amygoldlist/aggRviz: A package for dealing with data aggregated at many levels

Contributing

aggRviz is a a new project, currently in development by our team (Susan Fung, Amy Goldlist and Fang Yang). If you are interested in helping us out, we welcome suggestions! Please read through the procedure below, check out our code of conduct and our license.

Raising issues

If you have any questions, concerns or suggestions, please raise an issue.

Using Github

Fork our repo at :

https://github.com/goldlist/aggRviz.git

Clone the repo:

git clone https://github.com/your_username/aggRviz.git

You can make changes in your local folder.

After you finish changes,

git commit

and

git push

the changes to your fork.

Then, submit a pull request.

At this point you're waiting on us. We like to at least comment on pull requests within three business days (and, typically, one business day). We may suggest some changes or improvements or alternatives.

Some things that will increase the chance that your pull request is accepted:

• Write tests.
• Write good descriptive commit messages.
• enable Travis CI on your forked repo and ensure that your commits are Green lit. Without passing Travis, we will not merge!
• Note: The Travis CI badge on the ReadMe is synced to the master repo at amygoldlist/aggRviz, and so will show as green even if your fork fails. If you change the logo, please do not include this commit in your merge request!
• If you make changes to .travis.yml highlight the changes in your pull request. Please do not do this without good reason, instead, consider raising an issue.

If the pull requests do not have any conflicts, at least one team members will reviews the pull requests before they can be merged.

Attribution

This document is adapted from factory-bot-rails/CONTRIBUTING.md.

amygoldlist/aggRviz documentation built on May 16, 2019, 11:10 p.m.