Contribute
We welcome contributions to the Arts Oven UI Component Library! Whether you’re fixing bugs, adding new features, or improving documentation, your help is greatly appreciated. Follow the steps below to get started with contributing to our project.
How to Contribute
Step 1: Fork the Project
- Visit the Arts Oven UI GitHub Repository.
- Click on the Fork button located at the top right corner of the page. This will create a copy of the repository under your GitHub account.
Step 2: Clone Your Fork
Once you have forked the repository, you need to clone it to your local machine. Follow these steps:
- Open your terminal.
- Run the following command, replacing
your-username
with your actual GitHub username:
git clone https://github.com/your-username/artsovenui.git
- Navigate into the cloned directory:
cd artsovenui
Step 3: Set Up Your Development Environment
Before you start making changes, ensure that you have all necessary dependencies installed. Run the following command to install them:
npm install
Step 4: Make Your Changes
Now you can start making changes to the codebase! Here are some tips for contributing:
- Bug Fixes: If you find a bug, try to reproduce it and fix it in your local copy.
- New Features: If you want to add a new feature, consider discussing it first by opening an issue in the repository.
- Documentation: Help improve our documentation by clarifying instructions or adding new examples.
Step 5: Commit Your Changes
Once you are satisfied with your changes, commit them using:
git add .
git commit -m "Brief description of your changes"
Step 6: Push Your Changes
Push your changes back to your forked repository on GitHub:
git push origin main
Step 7: Create a Pull Request
- Go back to the original repository on GitHub.
- You should see a prompt to create a pull request for your recently pushed branch.
- Click on Compare & pull request.
- Add a description of your changes and submit the pull request.
Conclusion
Thank you for considering contributing to the Arts Oven UI Component Library! We appreciate your efforts in helping us improve and grow our project. If you have any questions or need assistance during the process, feel free to reach out through our community support channels or open an issue in the GitHub repository. Happy coding!