Skip to content

Latest commit

 

History

History
97 lines (62 loc) · 2.84 KB

CONTRIBUTING.md

File metadata and controls

97 lines (62 loc) · 2.84 KB

👷 Contributing to Librarian

Thank you for considering contributing to the Librarian! Welcome to our Contribution Guide.

Table of Contents

  1. Getting Started
  2. Reporting an Issue
  3. Cloning the repository
  4. Troubleshoot

Getting Started

If you don't want contribute with code, but want to help us Reporting Issues, just skip to Reporting an Issue section.

However, if you prefer to work with code, simply go to Cloning the repository section and continue to the end of this document.

Reporting an Issue

  1. Describe what you expected to happen and what actually happens.

  2. If possible, include a minimal but complete example to help us reproduce the issue.

  3. We'll try to fix it as soon as possible but be in mind that Librarian is open source and you can probably submit a pull request to fix it even faster.

  4. Just open your issue.

Cloning the repository

First of all you'll need some tools like NodeJS and Git to get your development environment working, as code editor we use Visual Studio Code, but it's only a suggestion, use whatever code editor you want.

Second you'll need to install some prerequisites (at least for Debian distros):

sudo apt install dpkg fakeroot build-essential

And now, you can clone by https:

git clone https://github.com/librarian-org/librarian.git

Or by SSH:

git clone [email protected]:librarian-org/librarian.git

Whatever you prefer. Clone the repo and start your work following this steps (aka gitflow):

  1. 🔧 Create a new branch based on main
  2. ✅ Name you branch how you prefer BUT main
  3. 🎨 Do the best of your art
  4. 📝 Make commit with a clear message
  5. 👌 Open a pull request from your new branch to main

Maybe you ask yourself: How can I contribute? or What i can do?

We'll help you:

  • You can find and fix bugs;
  • Implement openned issues;
  • Improve the Librarian programming.

Troubleshoot

You may face problems with yarn start script. If say so do this steps:

cat .yarnrc

It should return the results below:

# THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
# yarn lockfile v1

lastUpdateCheck 1637669537223

If you don't see any entry for python (preferred 3.8.10) you must put it manually:

yarn config set python "/usr/bin/python3"

When you execute cat .yarnrc again, it should show you:

# THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
# yarn lockfile v1


lastUpdateCheck 1637669537223
python "/usr/bin/python3" # <-- this line was added.