Skip to content

Latest commit

 

History

History
101 lines (61 loc) · 3.2 KB

CONTRIBUTING.md

File metadata and controls

101 lines (61 loc) · 3.2 KB
Raw

🇧🇷 Leia em Português | 🇺🇸 Read in English

Contribution Guide for -O-id

We are excited that you are interested in contributing to -O-id! Your help is essential to continue improving this library and ensuring that it meets the needs of the developer community. This document aims to guide you on how to contribute effectively.

How to Contribute

There are several ways to contribute to the -O-id project:

  1. Report Issues: If you find a bug or unexpected behavior, open an issue so we can investigate and fix it.
  2. Suggest Features: If you have ideas for new features or improvements, we would be happy to receive them.
  3. Submit Pull Requests: If you already have a solution for a problem or an improvement in mind, feel free to submit a pull request.

Getting Started

1. Fork the Repository

First, create a fork of the -O-id repository to your GitHub account. You can do this by clicking the "Fork" button in the upper right corner of the repository page.

2. Clone the Repository

After forking, clone the repository to your local machine:

git clone https://github.com/bake-js/-O-id.git
cd element

3. Install Dependencies

Before you start developing, install all the project dependencies:

bun install

4. Create a Branch for Your Work

Create a branch to isolate your work:

git checkout -b my-amazing-branch

5. Make Your Changes

Now you are ready to make your changes! Be sure to follow the coding guidelines and add tests if necessary.

6. Test Your Changes

Before submitting your changes, run the tests to ensure everything is working correctly:

bun test

7. Submit Your Changes

After testing your changes, commit and push your modifications to your repository:

git add .
git commit -m "Description of what was changed"
git push origin my-amazing-branch

8. Open a Pull Request

Finally, go back to the original repository on GitHub and open a pull request to the main branch. Briefly describe the changes you made and how they improve the project.

Contribution Guidelines

Code Style

  • Follow the JavaScript code conventions used in the project.
  • Use Biome to ensure formatting consistency.
  • Name your variables and functions descriptively and clearly.

Tests

  • Add tests for any new features or bug fixes.
  • Ensure that all existing tests continue to pass after your changes.

Documentation

  • Keep the documentation updated with any changes in functionality.
  • If you add a new feature, include usage examples in the documentation.

Communication

  • If you are unsure how to proceed with a change or need guidance, open an issue to discuss the idea before you start working.
  • Feel free to participate in discussions on existing issues, even if you are not working on a solution.

Code of Conduct

We expect all contributors to respect our Code of Conduct, maintaining a welcoming and respectful environment for everyone.

Acknowledgments

Thank you for considering contributing to -O-id! Your participation is essential for the growth and success of the project.