Skip to content

Latest commit

 

History

History
62 lines (41 loc) · 3.23 KB

CONTRIBUTING.md

File metadata and controls

62 lines (41 loc) · 3.23 KB

Contributing to PM2 UI

First off, thank you for considering contributing to PM2 UI! It's people like you that make the open source community such a great place to learn, inspire, and create. Any contributions you make are greatly appreciated.

Code of Conduct

This project and everyone participating in it is governed by the PM2 UI Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to [[email protected]].

How Can I Contribute?

Reporting Bugs

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

  • Use a clear and descriptive title for the issue to identify the problem.
  • Provide a step-by-step description of the suggested enhancement in as many details as possible.
  • Provide specific examples to demonstrate the steps. Include links to files or GitHub projects, or copy/pasteable snippets, which you use in those examples.
  • Describe the behavior you observed after following the steps and point out what exactly is the problem with that behavior.
  • Explain which behavior you expected to see instead and why.
  • Include screenshots and animated GIFs which show you following the described steps and clearly demonstrate the problem.

Suggesting Enhancements

This section guides you through submitting an enhancement suggestion for PM2 UI, including completely new features and minor improvements to existing functionality.

  • Use a clear and descriptive title for the issue to identify the suggestion.
  • Provide a step-by-step description of the suggested enhancement in as many details as possible.
  • Provide specific examples to demonstrate the steps. Include copy/pasteable snippets which you use in those examples, as Markdown code blocks.
  • Describe the current behavior and explain which behavior you expected to see instead and why.
  • Explain why this enhancement would be useful to most PM2 UI users and isn't something that can or should be implemented as a community plugin.

Pull Requests

  • Fill in the required template
  • Do not include issue numbers in the PR title
  • Include screenshots and animated GIFs in your pull request whenever possible.
  • Follow the JavaScript and React styleguides.
  • Include thoughtful comments in your code.
  • Document new code based on the documentation styleguide
  • End files with a newline.
  • Avoid platform-dependent code

Styleguides

Git Commit Messages

  • Use the present tense ("Add feature" not "Added feature")
  • Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
  • Limit the first line to 72 characters or less
  • Reference issues and pull requests liberally after the first line

JavaScript Styleguide

All JavaScript must adhere to JavaScript Standard Style.

React Styleguide

All React code must adhere to the React Best Practices.

License

By contributing to PM2 UI, you agree that your contributions will be licensed under its MIT License.