UNPKG

@sujalchoudhari/solaris-ui

Version:

A UI framework to create HTML pages with just JavaScript.

43 lines (33 loc) 2.72 kB
# Contribution Guide ## Choose an issue Take a look at our issue tracker on GitHub and find an issue that interests you. We label issues with "beginner-friendly" and "good first issue" to make it easier for newcomers to get involved. ## Set up your development environment To contribute to our project, you'll need to set up your development environment. This includes installing any required dependencies, setting up a development server, and configuring your IDE. Check the README file in the project's repository for instructions on how to do this. ## Fork the repository Once you've found an issue you'd like to work on and have your development environment set up, fork our repository on GitHub. This will create a copy of the project that you can work on without affecting the original codebase. ## Create a new branch Create a new branch for your changes with a name that reflects the issue you're working on. For example, if you're fixing a bug related to the login feature, you could name your branch "fix-login-bug". This will make it easier for others to understand what your changes are addressing. To create a new branch, use the following command: ```bash git checkout -b your-branch-name ``` Make your modifications in this branch and commit your changes regularly. Remember to write clean, concise code and follow our coding standards. If you need help or have questions, feel free to ask on our project's discussion forum. By creating a separate branch, you'll be able to work on your changes without affecting the main codebase. Once your changes are complete, you can submit a pull request to merge your branch into the main codebase. ## Make your changes Create a new branch for your changes and make your modifications. Remember to write clean, concise code and follow our coding standards. If you need help or have questions, feel free to ask on our project's discussion forum. ## Submit a pull request When you're ready to submit your changes, create a pull request. This will allow us to review your changes and merge them into the main codebase if they meet our standards. ## Communicate with the community Engage with our community by commenting on issues, discussing your contributions, and providing feedback to others. This will help you build relationships with other contributors and grow your skills as a developer. ## Keep learning Open source is a great way to learn new skills and technologies. As you contribute to our project, take the opportunity to learn from other contributors and explore new areas of development. Thank you for considering contributing to our open source project! We look forward to working with you.