CONTRIBUTING.md

In tguo9/samplingsimulatorr: What the Package Does (One Line, Title Case)

Contributing

Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.

You can contribute in many ways:

Types of Contributions

Report Bugs

Report bugs here.

If you are reporting a bug, please include:

• Your operating system name and version.
• Any details about your local setup that might be helpful in troubleshooting.
• Detailed steps to reproduce the bug.

Fix Bugs

Look through the GitHub issues for bugs. Anything tagged with "bug" and "help wanted" is open to whoever wants to implement it.

Implement Features

Look through the GitHub issues for features. Anything tagged with "enhancement" and "help wanted" is open to whoever wants to implement it.

Write Documentation

samplingsimulatorr could always use more documentation, whether as part of the official samplingsimulatorr docs, in docstrings, or even on the web in blog posts, articles, and such.

Submit Feedback

The best way to send feedback is to file an issue here.

If you are proposing a feature:

• Explain in detail how it would work.
• Keep the scope as narrow as possible, to make it easier to implement.
• Remember that this is a volunteer-driven project, and that contributions are welcome :)

Get Started!

Ready to contribute? Here's how to set up samplingsimulatorr for local development.

1. Fork the samplingsimulatorr repo on GitHub.

2. Clone your fork locally:

   git clone [e-mail]:your_name_here/samplingsimulatorr.git 3. Add upstream:

   git remote add upstream https://github.com/UBC-MDS/samplingsimulatorr.git

3. Create a branch for local development:

   git checkout -b name-of-your-bugfix-or-feature

   Now you can make your changes locally.

4. When you're done making changes, check that your changes pass the tests by running check()

   library(devtools) check()

5. Commit your changes and push your branch to GitHub:

   git add . git commit -m "Your detailed description of your changes." git push origin name-of-your-bugfix-or-feature

6. Submit a pull request through the GitHub website here.

Pull Request Guidelines

Before you submit a pull request, check that it meets these guidelines:

1. The pull request should include tests.
2. If the pull request adds functionality, the docs should be updated. Put your new functionality into a function with a docstring, and add the feature to the list in README.md.

Code of Conduct

Please note that the samplingsimulatorr project is released with this Contributor Code of Conduct. By contributing to this project you agree to abide by its terms.

tguo9/samplingsimulatorr documentation built on May 5, 2020, 12:10 a.m.