Skip to content

Latest commit

 

History

History
47 lines (37 loc) · 1.73 KB

CONTRIBUTING.md

File metadata and controls

47 lines (37 loc) · 1.73 KB

Contributing to File-Sys-Cache

Welcome to File-Sys-Cache! We're thrilled that you're interested in contributing. Before you get started, please take a moment to review the following guidelines.

How to Contribute

  1. Fork the repository and clone it to your local machine.
  2. Create a new branch for your contribution: 
    git checkout -b feature/my-new-feature
  3. Commit your changes: 
    git commit -am 'Add my new feature'
  4. Push to your forked repository: 
    git push origin feature/my-new-feature
  5. Create a new pull request from your forked repository to the main repository's main branch.

Code Style

Please follow the existing code style and conventions used in the project. If you're unsure about anything, feel free to ask for clarification. In order to check for errors you can run

npm run lint

Testing

Ensure that your changes are covered by tests. *.spec.js Run the test suite before submitting a pull request:

npm run test

Documentation

If you're introducing new features or making significant changes, please update the documentation accordingly.

Issues

If you encounter any bugs, issues, or have feature requests, please open a new issue on the GitHub repository.

Code of Conduct

Please note that File-Sys-Cache has a Code of Conduct. By participating in this project, you agree to abide by its terms.

License

By contributing to File-Sys-Cache, you agree that your contributions will be licensed under the project's MIT License.

Thank you for contributing!