• Mayank Mittal's avatar
    Adds codespell to pre-commit configuration file (#38) · f2d97bdc
    Mayank Mittal authored
    # Description
    
    <!--
    Thank you for your interest in sending a pull request. Please make sure to check the contribution guidelines.
    
    Link: https://isaac-orbit.github.io/orbit/source/refs/contributing.html
    -->
    
    Since many of us are working, it makes sense to have a spell checker to ensure we have the right words everywhere. The PR adds [codespell](https://github.com/codespell-project/codespell) to the pre-commit file that allows checking for typos/spellings in the repository.
    
    The tool is available under a GPL-2.0 license and is fetched using its PyPi release. The repo's BSD-3 is compatible with  GNU-GPL family of licenses.  We do not modify any of the codespell's source code. The license file is included in the repository for the sake of completion.
    
    <!-- As a practice, it is recommended to open an issue to have discussions on the proposed pull request.
    This makes it easier for the community to keep track of what is being developed or added, and if a given feature
    is demanded by more than one party. -->
    
    ## Type of change
    
    <!-- As you go through the list, delete the ones that are not applicable. -->
    
    - New feature (non-breaking change which adds functionality)
    
    <!--
    Example:
    
    | Before | After |
    | ------ | ----- |
    | _gif/png before_ | _gif/png after_ |
    
    To upload images to a PR -- simply drag and drop an image while in edit mode and it should upload the image directly. You can then paste that source into the above before/after sections.
    -->
    
    ## Checklist
    
    - [x] I have run the [`pre-commit` checks](https://pre-commit.com/) with `./orbit.sh --format`
    - [x] I have made corresponding changes to the documentation
    - [x] My changes generate no new warnings
    - [ ] I have added tests that prove my fix is effective or that my feature works
    - [ ] I have updated the changelog and the corresponding version in the extension's `config/extension.toml` file
    
    <!--
    As you go through the checklist above, you can mark something as done by putting an x character in it
    
    For example,
    - [x] I have done this task
    - [ ] I have not done this task
    -->
    f2d97bdc
codespell-license.txt 17.7 KB