Skip to content

Latest commit

 

History

History
62 lines (43 loc) · 1.99 KB

CONTRIBUTING.md

File metadata and controls

62 lines (43 loc) · 1.99 KB

Contributing to LetXPath

👍🎉 First off, thanks for taking the time to contribute! 🎉👍

The following is a set of guidelines for contributing to LetXPath. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.

Table Of Contents

Code of Conduct

Coding style:

  1. Use camel case for any variable for functions
  2. Use the regular function in content and other related files to avoid hoisting problem
  3. All code must have high-level comments
  4. The naming convention must be understandable
  5. Write simple and effective code
  6. Before committing the code, test it with a minimum of five different application

Checkout code with the following prefixes:

  1. 📦 NEW: - If it's a new feature (eg., 📦 NEW: -Faker API)
  2. 👌 IMPROVE: - For local commit and push in the existing work
  3. 🐛 FIX: - If fixing any bug
  4. 🐧 UI - If anything related UI improvements or bugs
  5. 🤖 TEST: - Testing the product
  6. 📖 DOC: - If any documentations or videos
  7. 🚀 RELEASE: If everything goes right

Yes! emojis are important. Something missing feel free to add

What should I know before I get started?

  1. Willing to contribute
  2. Knowledge on JavaScript is very important
  3. Knowledge of XPath pattern
  4. Knowledge on DOM traversal

How Can I Contribute?

Anyone can contribute to our project in four ways

  1. By developing the XPath pattern
  2. By designing the UI
  3. By testing and reporting to us
  4. The most important by sharing to the world

Help

I don't know how does it work, but I like to contribute. What should I do next?

No worries LetCode has created all the basic video on how to build LetXPath Feel free to check out our get started videos and we appreciate your contribution

YouTube