Skip to content

Latest commit

 

History

History
71 lines (39 loc) · 1.55 KB

CONTRIBUTING.md

File metadata and controls

71 lines (39 loc) · 1.55 KB

Contributing to onsubmit

Code contributions

Here is a quick guide to doing code contributions to the library.

  1. Fork and clone the repo to your local machine git clone https://github.com/AmmarHalees/onsubmit.git

  1. Create a new branch from main with a meaningful name for a new feature or an issue you want to work on: git checkout -b your-meaningful-branch-name

  1. Use the recommended node version:

    nvm use
    
  2. Install packages by running:

    pnpm install
    
  3. Run the tests to ensure everything is working correctly as you're making changes.

    pnpm run dev
    
  4. Try to write some unit tests to cover as much of your code as possible.


  1. Ensure your code lints without errors.

    pnpm lint
    
  2. Ensure the build and tests pass before commiting your changes

    pnpm run ci
    
  3. Ensure exports are documented.

  4. Push your branch: git push -u origin your-meaningful-branch-name

  5. Submit a pull request to the upstream onsubmit repository.

  6. Choose a descriptive title and describe your changes briefly.

Documentation

In case you want to change the README.md, please instead modify the docs/Template.md file, as the README is generated from it upon committing.

License

By contributing your code to the onsubmit GitHub repository, you agree to license your contribution under the MIT license.

Contributors