Contributing

Contributing

Here is some description about contributing to the project. Follow the steps below to set up the project locally.

Step 1: Clone the Repository

First, clone the repository to your local machine by running the following command:

git clone https://github.com/Elue-dev/js-logs-formatter.git

Step 2: Navigate to the Project Directory

cd js-logs-formatter

Step 3: Install Dependencies

pnpm install

Step 4: Make Your Code Changes

Now that you have the project set up, you can start making your code changes or implementing new features. Here are some tips to keep in mind:

  • Follow Coding Standards: Ensure your code adheres to the project’s coding conventions.
  • Test Your Changes: Write tests to cover your changes, ensuring everything works as intended.
  • Commit Often: Make small, frequent commits with clear messages to document your progress.

Step 5: Open a Pull Request

Once you’ve made your changes and are satisfied with your work, it’s time to submit a Pull Request (PR):

  1. Push Your Changes: Push your branch to your forked repository:

    git push origin your-branch-name

  2. Open a Pull Request: Go to the original repository on GitHub and click on the “Pull Requests” tab. Click “New Pull Request,” select your branch, and provide a clear description of your changes.

  3. Request Review: After creating the PR, you can request reviews from the maintainers to get feedback on your work and merge the PR.

API Reference