CONTRIBUTING.md

In UBC-MDS/xplrrr: This package makes exploratory data analysis (EDA) simple and seamless. EDA is a crucial phase in the data science workflow as it allows us get a fist glimpse of the data. It is important to identify statistical characteristics of the data so that we can properly set up the rest of the analysis

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 at https://github.com/UBC-MDS/pyxplr/issues.

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

pyxplr could always use more documentation, whether as part of the official pyxplr 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 at https://github.com/UBC-MDS/pyxplr/issues.

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 :)

Submitting Your Contributions

Internal Contributions

We utilize Github Flow approach. If you have been granted access to the repository, please follow this approach. All development should be done in feature-specific branches branched off master. Once ready, submit a pull request from your feature branch to master.

External Contributions

Even if you are not a team member, your contributions are very welcome. In this case please use fork+PR approach - fork the repository, work on your changes and then submit a pull request back to the repository. We will be glad to review and hopefully approve it!

Code of Conduct

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

UBC-MDS/xplrrr documentation built on April 2, 2020, 4 a.m.