CONTRIBUTING.md

September 17, 2024 ยท View on GitHub

Contributiong Guidelines

Thank you for your interest in contributing to nvim-http-client! We welcome contributions from everyone.

Making Changes

  1. Make your changes in your branch
  2. Add or update tests as necessary
  3. Ensure all tests pass by running make test
  4. Update documentation if you're changing functionality.

Updating the Changelog

For every pull request, please ensure that you update the CHANGELOG.md file. Your changes should be added under a new heading with today's date if no entry for today exists yet. If an entry for today already exists, add your changes under the appropriate subsection.

## [Version X.X.X] - YYYY-MM-DD

### Added
- [Description of new feature or enhancement]
- [API endpoints or commands added]

### Changed
- [Description of improvements or refactors]
- [Updated dependencies]

### Deprecated
- [Description of any deprecations]

### Removed
- [Description of features or code removed]

### Fixed
- [Bug fixes or minor corrections]
- [Description of the issue resolved]

### Security
- [Details about security fixes or improvements]