diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..fb009b8 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,60 @@ +# Contributing to `pr-manager` + +Thank you for your interest in contributing to this project! Please review these guidelines before getting started. + +## Issue Reporting + +### When to Report an Issue + +- You've discovered bugs but lack the knowledge or time to fix them +- You have feature requests but cannot implement them yourself + +> ⚠️ **Important:** Always search existing open and closed issues before submitting to avoid duplicates. + +### How to Report an Issue + +1. Open a new issue +2. Provide a clear, concise title that describes the problem or feature request +3. Include a detailed description of the issue or requested feature + +## Code Contributions + +### When to Contribute + +- You've identified and fixed bugs +- You've optimized or improved existing code +- You've developed new features that would benefit the community + +### How to Contribute + +1. **Fork the repository and check out a secondary branch** + +2. **Set up pre-commit hooks** + + ```bash + pip install pre-commit + pre-commit install + ``` + +3. **Make your changes and test** + + ```bash + make format-check + make lint + ``` + + Ensure that all files are correctly formatted and linted. + + Format files with `make format`. + +4. **Commit your changes** + +5. **Verify pre-commit compliance** + Ensure your changes pass all linting checks. + +6. **Submit a pull request** + Include a comprehensive description of your changes. + +--- + +**Thank you for contributing!** diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..5071fc5 --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +The MIT License + +Copyright (c) LlamaIndex + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in +all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +THE SOFTWARE. \ No newline at end of file