Skip to content

Latest commit

 

History

History
51 lines (40 loc) · 1.58 KB

TODO.md

File metadata and controls

51 lines (40 loc) · 1.58 KB
Raw

TODO List for Your NPM Package Template

Use this checklist to guide you through the setup and customization process of your NPM package based on this template.

  1. Clone the Repository:

    git clone https://github.com/Ram-Amoncar/npm-package-template.git your-package-name

  2. Navigate to the New Package Directory:

    cd your-package-name

  3. Install Dependencies:

    npm install

  4. Customize Your Package:

    • Update package.json with your package details (name, version, description, keywords, author, repository.).
    • Implement your package logic in the src directory.
    • Adjust tsup.config.js if needed for your project structure.

  5. Build Your Package:

    npm run build

  6. Run Tests:

    npm test

  7. Linting and Formatting:

    npm run lint
npm run format

    Ensure your code adheres to the specified coding standards.

    • Confirm there are no linting errors.
    • Confirm code formatting is consistent.

  8. Documentation:

    • Update the README.md file to provide relevant information about your specific package.
    • Remove unnecessary sections from this template.

  9. Contribute:

    • If you find issues or have suggestions for improvements in the template itself, feel free to contribute by submitting pull requests.

Remember to replace placeholders such as your-username and your-package-name with your actual GitHub username and the desired name for your new package. Mark the checkboxes as you complete each task.