Skip to content

Latest commit

 

History

History
108 lines (70 loc) · 3.76 KB

CONTRIBUTING.md

File metadata and controls

108 lines (70 loc) · 3.76 KB
Raw

Contributing to Lupo Skill

Thank you for considering contributing to Lupo Skill. We appreciate your interest in improving our platform. To ensure smooth collaboration, please follow these guidelines when contributing.

  • We allow a maximum of 2 issues to be assigned per person.
  • The issues are assigned on FIRST-COME-FIRST-SERVE basis.
  • Always use the issue and PR templates provided.

You can find the video for setup here

Getting Started

  1. Fork the repository: Start by forking the Lupo Skill repository to your own GitHub account.
  2. Clone the repository: Clone the forked repository to your local machine using Git.
git clone https://github.com/your-username/lupo-skill.git
  1. Navigate to the project directory:
cd lupo-skill
  1. Install dependencies: Use npm to install the project dependencies.
npm install
  1. Set up Firebase:
  • Create a Firebase project on the Firebase console.
  • Configure Firebase authentication, Firestore database(rtdb), and storage (remeber to edit the rules).
  • Update Firebase configurations in the project. in firebaseConf.ts
  1. Run the website
npm run start

  1. Make your changes: Implement your changes or add new features to the codebase.

  2. Commit your changes: Commit your changes with clear and descriptive messages.

git commit -m "Your commit message"
  1. Create a branch: Create a new branch in your fork.
git branch <branch name>
  1. Switch to the created branch
git checkout <branch name>
  1. Push your changes: Push your changes to your forked repository.
git push origin <branch name>
  1. Create a pull request: Submit a pull request to the Lupo Skill repository.

Contribute using GitHub Desktop

  1. Launch GitHub Desktop: Open GitHub Desktop and sign in to your GitHub account if necessary.

  2. Clone the Repository:

    • If you haven't already cloned the lupo-skill repository, go to the "File" menu and select "Clone Repository.
    • Find and select the lupo-skill repository from the list of repositories on GitHub, then clone it to your local machine.

  3. Switch to the Correct Branch:

    • Make sure you're on the correct branch for your pull request.
    • If you need to switch branches, use the "Current Branch" dropdown menu to select the appropriate branch.

  4. Edit the Files: Use your preferred code editor to make the necessary changes to the code or files in the repository.

  5. Commit Your Changes:

    • In GitHub Desktop, review the list of modified files. Check the box next to each file you want to include in the commit.
    • Write a summary and description for your changes in the "Summary" and "Description" fields, then click the "Commit to " button to commit the changes to your local branch.

  6. Push Changes to GitHub: After committing your changes, click the "Push origin" button in the top right corner of GitHub Desktop to push your changes to your forked repository on GitHub.

  7. Create a Pull Request:

    • Navigate to the GitHub website and go to your fork of the lupo-skill repository.
    • Click the "Compare & pull request" button to start a pull request between your fork and the original repository.

  8. Review and Submit:

    • On the pull request page, review your changes and add any additional information, such as a title and description.
    • Once you are satisfied with the details, click the "Create pull request" button to submit your pull request.

  9. Await Review: Your pull request will be reviewed by the project maintainers. They may provide feedback or request changes before merging your pull request into the main branch of the lupo-skill repository.