Thank you for your interest in contributing to EmbedPG! We welcome contributions from the community and are grateful for your help.
-
Fork the Repository: Start by forking the EmbedPG repository to your GitHub account.
-
Clone Your Fork: Clone your forked repository to your local machine.
git clone https://github.com/your-username/embed-pg.git
-
Create a Branch: Create a new branch for your changes. Use a descriptive name for your branch.
git checkout -b feature/your-feature-name
-
Make Your Changes: Make the necessary changes in your local repository.
-
Commit Your Changes: Commit your changes with a descriptive commit message.
git add . git commit -m "Description of your changes"
-
Push to Your Fork: Push your changes to your forked repository on GitHub.
git push origin feature/your-feature-name
-
Open a Pull Request: Open a pull request to the main repository. Describe your changes and why they should be merged.
- Code Quality: Ensure your code follows best practices and is well-documented.
- Tests: Write tests for your code to ensure it works as expected.
- Commit Messages: Write clear and concise commit messages.
- Pull Request Description: Provide a detailed description of your changes in the pull request.