Skip to content

Latest commit

 

History

History
24 lines (18 loc) · 1.82 KB

CONTRIBUTING.md

File metadata and controls

24 lines (18 loc) · 1.82 KB

Contributing Guidelines

Hello! 👋 Thank you for considering contributing to this project. PNLS is an open source project and there are many ways to contribute, from documentation improvements, submitting feature requests, pull requests with changes and improvements or bug reports. Don't use Issues for support questions, for those you can start a discussion.

Contributions to this project are released to the public under the project's open source license.

Submitting a pull request

  1. Fork and clone the repository
  2. Create a new branch: git checkout -b branch-name
  3. Make your change
  4. Push to your fork and submit a pull request
  5. Wait for your pull request to be reviewed and merged.

Here are a few things you can do that will increase the likelihood of your pull request being accepted:

  • Follow the style guide.
  • Follow the used Coding Guidelines.
  • Keep your change as focused as possible. If there are multiple changes you would like to make that are not dependent upon each other, consider submitting them as separate pull requests.
  • Write a good commit message.
    • Use the best practices described in this guide.
    • Consider using Gitmoji.
  • Also, take a look at How to Contribute to Open Source.