Contributing to the NameForMe Package¶

Thank you in advance in making contribution to the package. Any suggestions would be greatly appreciated!

Contributors¶

Daniel Cairns
Eyre Hong
Bruce Wu
Zilong Yi

Types of Contributions¶

Here, we list several ways in making contribution to this package.

Fixing typos¶

Small typos or grammatical errors in documentation may be edited directly using the GitHub web interface, so long as the changes are made in the source file.

YES: you edit a roxygen comment in a .R file below R/.
NO: you edit an .Rd file below man/.

Report Bugs¶

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¶

You can never have enough documentation! Please feel free to contribute to any part of the documentation, such as the official docs, docstrings, or even on the web in blog posts, articles, and such.

Submit Feedback¶

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 nameforme for local development.

Download a copy of nameforme locally.
Install nameforme using poetry:
```
$ poetry install
```
Use git (or similar) to create a branch for local development and make your changes:
```
$ git checkout -b name-of-your-bugfix-or-feature
```
When you’re done making changes, check that your changes conform to any code formatting requirements and pass any tests.
Commit your changes and open a pull request.

Pull Request Guidelines¶

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

Before you make a substantial pull request, you should always file an issue and make sure someone from the team agrees that it’s a problem.
The pull request should be created under a self branch if possible.
If the pull request relates to any of the functions in the package, the documentation should be updated as well.
The pull request should work for all currently supported operating systems and versions of Python.

Code of Conduct¶

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

Attribution¶

These contributing guidelines were adapted from the dplyr contributing guidelines.