Skip to content

StarShopCr/contributors-guide

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

17 Commits
 
 
 
 

Repository files navigation

StarShop Contribution Guide💫

Welcome! Follow these steps to contribute effectively to the StarShop project. Let’s build a transparent, blockchain-powered marketplace together!


Important Note Before Applying 📝

⚠️ Avoid Generic Comments:

Comments like:

🚫 "Can I help on this one?"

🚫 "I’d love to contribute!"

🚫 "Checkout my profile!"

🚫 "Can I tackle this?"

Won't be considered, and you won't be assigned.

Instead, provide a **clear explanation of your approach **, including:

  • An introduction about yourself
  • A concise plan to solve the issue (6-8 lines max).
  • Your estimated completion time (ETA).

Steps to Contribute🤝

1. Apply for an Issue

  • Look for an open issue and comment expressing your interest to work on it.
  • Wait for the maintainer to assign the issue to you.
  • Remember to apply only if you are able to solve the issue.
  • In the comment, Add a quick introduction about yourself, The ETA, and how you plan to tackle the issuee.

2. Contact the Maintainer📲

Once assigned, contact the maintainer via Telegram to let them know you’re currently working on the assigned issue and provide a brief idea of how you plan to tackle it.

Telegram: @StarShop


3. Fork and Clone the Repository

  1. Fork the repository from GitHub.
  2. Clone it to your local machine:
    git clone https://github.com/your-username/[reponame].git
    cd [reponame]

4. Create a Branch

Create a new branch to work on the issue:

git checkout -b feature/issue-title

5. Write Code

  • Follow coding standards (ESLint, Prettier).
  • Ensure your code is well-documented and tested.

6. Submit a Pull Request

  1. Push your branch to GitHub:
    git push origin feature/issue-title
  2. Open a pull request (PR) with:
    • A clear description of your solution.
    • A reference to the issue number.

Wait for reviews, make updates if needed, and get your PR merged!
For faster review, contact the maintainer via Telegram.


Commit Message Guidelines

Use the following types for your commit messages:

  • feat: A new feature
  • fix: A bug fix
  • docs: Documentation only changes
  • style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc.)
  • refactor: A code change that neither fixes a bug nor adds a feature (improvements of the code structure)
  • perf: A code change that improves performance
  • test: Adding missing or correcting existing tests
  • build: Changes that affect the build system or external dependencies (example scopes: gulp, npm)
  • ci: Changes to CI configuration files and scripts (example scopes: travis, circle)
  • chore: Other changes that don't modify src or test files
  • revert: Reverts a previous commit

Thank you for contributing to StarShop! Let us know if you need any help.

About

here is our contributors guide

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published