Skip to content

Latest commit

 

History

History
50 lines (37 loc) · 2.13 KB

CONTRIBUTING.md

File metadata and controls

50 lines (37 loc) · 2.13 KB
Raw

Contributing to Rust Keyword Extraction

I appreciate your interest in contributing to Rust Keyword Extraction! This document will provide some guidelines and best practices for submitting your contributions.

Reporting Issues

When reporting issues, please provide clear steps to reproduce the issue and any relevant information, such as the environment, operating system, and software versions.

Feature Requests

We welcome feature requests. Please open an issue describing the feature, its benefits, and potential implementation details.

Pull Requests

I gladly accept pull requests for bug fixes, new features, and improvements. Please follow these steps when submitting a pull request:

  1. Fork the repository and create a new branch with a descriptive name.
  2. Ensure that your changes adhere to the coding style and conventions used in the project.
  3. Test your changes thoroughly, and include unit tests when applicable.
  4. Update the documentation to reflect your changes, if necessary.
  5. Follow the Pull Request Template when creating a pull request.

File Headers

Please update the file headers for new files with your information, adhering to the LGPL-3.0 license:

// Copyright (C) <year> <your name>
//
// Rust Keyword Extraction is free software: you can redistribute it and/or modify
// it under the terms of the GNU Lesser General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// Rust Keyword Extraction is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public License
// along with Rust Keyword Extraction. If not, see <http://www.gnu.org/licenses/>.

License

By submitting a contribution, you agree that your contributions will be licensed under the GNU Lesser General Public License v3.0. See the Copying and Copying Lesser files for details.