Skip to content

Latest commit

 

History

History
37 lines (25 loc) · 1.88 KB

CONTRIBUTING.md

File metadata and controls

37 lines (25 loc) · 1.88 KB
Raw

Contributing to oji

👍🎉 First off, thanks for taking the time to contribute! 🎉👍

Please note we have a code of conduct, please follow it in all your interactions with the project.

How Can I Contribute?

Reporting Bugs

This section guides you through submitting a bug report for oji. Following these guidelines helps maintainers and the community understand your report 📝, reproduce the behavior 💻 💻, and find related reports 🔎.

When you are creating a bug report, explain the problem and include additional details to help maintainers reproduce the problem:

  • Use a clear and descriptive title for the issue to identify the problem.
  • Describe the exact steps which reproduce the problem in as many details as possible.
  • Include terminal output with error message.
  • Which version of Node.js are you using? You can run node -v in your terminal to see the version number.
  • What's the name and version of the OS you're using?
  • Check your grammar!

Note: If you find a Closed issue that seems like it is the same thing that you're experiencing, open a new issue and include a link to the original issue in the body of your new one.

Adding Enhancements

This section guides you through adding an enhancement for oji, including completely new features and minor improvements to existing functionality. Following these guidelines helps maintainers and the community understand your pull request :pencil:.

When you are creating a pull request:

  • Use a clear and descriptive title to identify the enhancement.
  • Provide a description of the enhancement in as many details as possible.
  • Explain why this enhancement would be useful?
  • Before submitting a code change, check the code style by running npm test.
  • Check your grammar!