Skip to content

Latest commit

 

History

History
67 lines (45 loc) · 2.68 KB

CONTRIBUTING.md

File metadata and controls

67 lines (45 loc) · 2.68 KB
Raw

Contributing

Thanks for your interest in the Pinterest API Quickstart code! Your contributions are welcome.

If you work with a Partner Manager at Pinterest, you can give them feedback on improvements that you would like to see in this Quickstart.

Help

If you're having trouble using this project, please start by reading the README.md and searching for solutions in the existing open and closed issues.

Security

If you've found a security issue in one of our open source projects, please report it at Bugcrowd; you may even make some money!

Code of Conduct

Please be sure to read and understand our CODE_OF_CONDUCT.md. We work hard to ensure that our projects are welcoming and inclusive to as many people as possible.

Reporting Issues

If you have a bug report, please provide as much information as possible so that we can help you out:

  • Version of the project you're using.
  • Code (or even better whole projects) that reproduce the issue.
  • Steps that reproduce the issue.
  • Stack traces for crashes.
  • Any logs produced.

Making Changes

  1. Fork this repository to your own account
  2. Make your changes and verify that tests pass
  3. Commit your work and push to a new branch on your fork
  4. Submit a pull request
  5. Check to make sure that the automated tests run by Github pass
  6. Participate in the code review process by responding to feedback

Once there is agreement that the code is in good shape, one of the project's maintainers will merge your contribution.

To increase the chances that your pull request will be accepted:

  • Follow the coding style
  • Write tests for your changes
  • Write a commit message that explains what you've changed and why

Testing

Each language subdirectory in this repo (nodejs and python) has a README file with instructions on how to run the tests and linters locally. Please ensure that the tests and linters run successfully before submitting a pull request.

Coding conventions

  • Please submit new unit tests for any code changes that you make.
  • The nodejs code uses eslint to enforce code standards.
  • Type python code uses black, isort, and flake8 to enforce code standards.
  • We try to keep the code in the different languages at the same level of functionality. Your help writing code in multiple languages would be appreciated, but is not required.

License

By contributing to this project, you agree that your contributions will be licensed under its license.