Skip to content

Latest commit

 

History

History
51 lines (34 loc) · 2.79 KB

CONTRIBUTING.md

File metadata and controls

51 lines (34 loc) · 2.79 KB

Contributing to pynipper-ng

Welcome developer, thanks for contributing to the project!

Reading and following these guidelines will help me make the contribution process easy and effective for everyone involved. It also communicates that you agree to respect the time of the developers managing and developing these open source projects. In return, we will reciprocate that respect by addressing your issue, assessing changes, and helping you finalize your pull requests.

Quicklinks

Code of Conduct

We take our open source community seriously and hold ourselves and other contributors to high standards of communication. By participating and contributing to this project, you agree to uphold our Code of Conduct.

Getting Started

Contributions are made to this repo via Issues and Pull Requests (PRs). A few general guidelines that cover both:

  • To report security vulnerabilities, please check our Security guide.
  • Search for existing Issues and PRs before creating your own.
  • We work hard to makes sure issues are handled in a timely manner but, depending on the impact, it could take a while to investigate the root cause. A friendly ping in the comment thread to the submitter or a contributor can help draw attention if your issue is blocking.

Issues

Issues should be used to report bugs, request a new feature, or to discuss potential changes before a PR is created. When you create a new Issue, a template will be loaded that will guide you through collecting and providing the information we need to investigate.

Please, fill the template issues with all possible data, attaching screenshots and detailed information. We will review, tag and assign this issues soon.

Pull Requests

PRs are always welcome and can be a quick way to get your fix or improvement. In general, PRs should:

  • Only fix/add the functionality in question.
  • Include documentation and a properly description in the repo.
  • All actions must be passed.

In general, we follow a fork model:

  1. Fork the repository to your own Github account
  2. Clone the project to your machine
  3. Create a branch locally with a succinct but descriptive name
  4. Install pre-commit with pip install pre-commit and configure it with pre-commit install.
  5. Commit changes to the branch
  6. Following any formatting and testing guidelines specific to this repo
  7. Push changes to your fork
  8. Open a PR in our repository. The PR must be merged into the pynipper-ng develop branch.