Contributing In Turtofo – Guidelines And Best Practices

Everyone is welcome to contribute to GoDaddy’s Open Source Software. Contributing doesn’t just mean submitting pull requests. You can also get involved by reporting/triaging bugs, or participating in discussions on the evolution of each project.

No matter how you want to get involved, we ask that you first learn what’s expected of anyone who participates in the project by reading these Contribution Guidelines.

Please Note: GitHub is for bug reports and contributions primarily – if you have a support question head over to GoDaddy’s Open Source Software Slack, or the Tartufo Mailing list.

Table Of Contents

• Answering Questions
• Reporting Bugs
• Triaging bugs or contributing code
• Code Review
• Attribution of Changes
• Writing Code
  • Setting Up A Development Environment
  • Code Style
• Running tests
• Contributing as a Maintainer
  • Issuing a New Release
• Additional Resources

Answering Questions

One of the most important and immediate ways you can support this project is to answer questions on Slack , Github, or the Tartufo Mailing list.

Whether you’re helping a newcomer understand a feature or troubleshooting an edge case with a seasoned developer, your knowledge and experience with Python or security can go a long way to help others.

Reporting Bugs

Do not report potential security vulnerabilities here. Refer to our security policy for more details about the process of reporting security vulnerabilities.

Before submitting a ticket, please be sure to have a simple replication of the behavior.

If the issue is isolated to one of the dependencies of this project, please create a Github issue in that project. All dependencies are open source software and can be easily found through PyPI.

Submit a ticket for your issue, assuming one does not already exist:

• Create it on our Issue Tracker
• Clearly describe the issue by following the template layout
  • Make sure to include steps to reproduce the bug.
  • A reproducible (unit) test could be helpful in solving the bug.
  • Describe the environment that (re)produced the problem.