Developer

Thank you for expressing your interest in contributing to Lovely Swap!

Lovely Swap is an open-source project. If you want to contribute to the project, this section is here to guide you through your first steps with the Lovely Swap team 💖

Before starting any development, we highly encourage you to submit an issue on Github to discuss the problem and the solution with the team.

Setup your dev environment

Install yarn If you haven't.

1. Fork and clone the repository

   Copy

   $ git clone [fork_repo_url]

2. Add upstream remote. E.g.

   Copy

   $ git remote add upstream https://github.com/Lovely-Swap/frontend-app.git

3. Make sure you have the latest version of the default branch ( main )

   Copy

   $ git checkout main
   $ git pull upstream main

4. Create your own branch and install dependencies

   Copy

   $ git checkout -b branch-name
   $ yarn

5. Happy coding 🎉

Coding rules

We try to maintain as much consistency as we can between each of our repository. Your pull request has more chances to be accepted if you follow the following rules, and write high quality code. Let's get started 💪

Use Typescript!

Our repo uses Typescript. Make sure you're familiar with Typescript’s best practices.

Some good practices

• Keep components as small and "dumb" as possible.

• Use Composition over Inheritance.

• Keep in mind that your code will be read and maintained by several other developers. Make it as clear and easy to update as possible.​

Creating your pull request

Your code is ready to be submitted for review, congratulations🥳

• All pull requests must have a description of what the PR is trying to accomplish.

• Keep pull requests as small as possible. Larger pull requests should be broken up into smaller chunks with a dedicated base branch. Please tag the PR's that are merging into your base branch with the epic tag.

• If possible self-review your PR and add comments where additional clarification is needed.

Create a draft PR as soon as possible so we can view your ongoing progress.

Pull Request Title

Pull Request Title should follow Conventional Commits.‌

Type	Description
build	Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm)
ci	Changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs)
docs	Documentation only changes
feat	A new feature
fix	A bug fix
perf	A code change that improves performance
refactor	A code change that neither fixes a bug nor adds a feature
style	Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
test	Adding missing tests or correcting existing tests

Thanks for helping us making Lovely Swap even more awesome ❤

Reward System Outline

1. Objective-Based Rewards

Focus Areas:

User Interface (UI) Enhancements

User Experience (UX) Improvements

Accessibility Features

Performance Optimization

Security Enhancements

New Functionalities and Features

Reward Criteria:

Rewards will be based on the significance and impact of the improvements.

Emphasis on innovative solutions that enhance usability.

2. Submission Process

Create your pull request

Your code is ready to be submitted for review, congratulations🥳

• All pull requests must have a description of what the PR is trying to accomplish.

• Keep pull requests as small as possible. Larger pull requests should be broken up into smaller chunks with a dedicated base branch. Please tag the PR's that are merging into your base branch with the epic tag.

• If possible self-review your PR and add comments where additional clarification is needed.

Create a draft PR as soon as possible so we can view your ongoing progress.

Pull Request Title

Pull Request Title should follow Conventional Commits.‌

3. Reward Types

Monetary Rewards:

• LOVELY tokens are distributed based on the complexity and impact of the contribution.

• Higher rewards for critical improvements or significant innovations.

Recognition and Badges:

• Public recognition in the project's communication channels (website, social media, newsletters).

• Award digital badges or certificates for milestone achievements.

Performance Bonuses:

• Additional bonuses for outstanding contributions that exceed expectations.

Unlock your potential and contribute to our project—rewards up to an astonishing $50,000. Your innovation can shape the future!