🤝 How to Contribute

👋 Introduction

Thank you for your interest in contributing to the Palmr. project! Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Whether you're fixing bugs, adding new features, improving documentation, or sharing ideas, every contribution helps make Palmr better for everyone. We welcome contributors of all experience levels - from beginners to seasoned developers. This comprehensive guide will walk you through the process of contributing to Palmr, from setting up your development environment to submitting your first pull request. We're excited to have you join our community of contributors!

🔑 GitHub Login

Before you can contribute, you need to be logged into your GitHub account. If you don't have an account yet, you can sign up for free at GitHub. Having a GitHub account is essential as it allows you to fork repositories, submit pull requests, and interact with other contributors. Make sure to use a professional email address when creating your account, and consider enabling two-factor authentication for enhanced security. Once your account is set up, you can customize your profile and start exploring the vast open-source community on GitHub.

🔍 Access the Repository

Once you're logged in, go to the Palmr repository by clicking on this link: https://github.com/kyantech/Palmr. The repository contains all the source code, documentation, and resources for the Palmr project. Take a moment to explore the repository structure, including the README file, which provides an overview of the project.

Alternatively, you can search for "Palmr" in the GitHub search bar and click on the repository owned by kyantech. When searching, make sure you're looking at the official repository by checking the owner and repository name. The repository should have a description that matches the Palmr project and show recent activity from the maintainers. You can also check the number of stars, forks, and watchers to verify you're accessing the correct repository.

🍴 Fork the Repository

To contribute to the project, you'll need to create your own copy of the repository. This is called a fork. Here's how to do it:

1. Click the Fork button at the top right of the repository page.
2. Select where you want to fork the repository (your personal account or an organization).
3. Wait a few moments while GitHub creates your fork.
4. This will create a copy of the repository under your GitHub account.
5. You'll be automatically redirected to your forked repository once it's ready.

The fork will maintain a connection to the original repository, allowing you to:

• Keep your fork synchronized with the original repository
• Submit pull requests from your fork to the original repository
• Work independently on your own copy without affecting the original

📥 Clone the Fork

Next, you’ll need to clone your forked repository to your local machine. Here’s how:

1. On your forked repository page, click the Code button.

2. Copy the repository URL (HTTPS or SSH).

3. Open your terminal or command prompt and run the following command to clone the repository:

   git clone <repository-url>

4. Navigate into the cloned directory:

   cd Palmr

🔄 Set up Base Branch

Before making changes, ensure your local repository is set up to track the next branch from the original Palmr repository. Here’s how:

1. Add the original Palmr repository as a remote:

   git remote add upstream https://github.com/kyantech/Palmr.git

2. Fetch the latest changes from the next branch:

   git fetch upstream next

3. Create a new branch for your contribution based on upstream/next:

   git checkout -b your-branch-name upstream/next

✏️ Make Local Changes

Now you're ready to make your contributions! This could include:

• Fixing a bug
• Adding a new feature
• Improving documentation
• Writing tests
• Enhancing performance
• Adding translations
• Improving accessibility
• Refactoring code
• Adding examples
• Reporting issues

Make your changes in your local repository using your preferred code editor. Here are some tips for making changes:

1. Follow the Style Guide: Make sure your code follows the project's coding standards and style guidelines
2. Test Your Changes: Run tests locally to ensure your changes don't break existing functionality
3. Keep Changes Focused: Make small, focused changes that address a single issue or feature
4. Document Your Changes: Add or update documentation as needed to explain your changes
5. Review Your Work: Double-check your changes before committing to ensure quality

Remember to regularly save your work and test your changes incrementally to catch any issues early in the development process.

📝 Use Conventional Commits

Once you’ve made your changes, commit them to your branch using Conventional Commits. Conventional Commits help maintain a clean and consistent commit history. Here’s how to format your commit messages:

Commit Message Format:
<type>(<scope>): <description>

Examples:

• feat: add user authentication
• fix(api): resolve null pointer exception
• docs: update README file
• chore: update dependencies

Steps to Commit:

1. Stage your changes:

   git add .

2. Commit your changes with a properly formatted message:

   git commit -m "feat: add new feature for user profiles"

📤 Push Changes

After committing your changes, you'll need to push them to your forked repository on GitHub. This step synchronizes your local changes with your remote repository. Here's how to do it:

1. First, ensure your branch is up-to-date with any remote changes:

   git pull origin your-branch-name

2. Then push your commits to your forked repository:

   git push origin your-branch-name

If this is the first time pushing this branch, you might need to set the upstream branch:

git push -u origin your-branch-name

If you encounter any errors while pushing:

• Make sure you have the correct permissions on your fork
• Verify your remote URL is correct using git remote -v
• Check if you need to authenticate with GitHub

🔀 Create Pull Request

Now that your changes are on GitHub, you can open a Pull Request (PR) to propose your changes to the next branch of the Palmr repository. Here’s how:

1. Go to your forked repository on GitHub.
2. Click the Pull Request button.
3. On the PR creation page:
   • Set the base repository to kyantech/Palmr.
   • Set the base branch to next.
   • Set the head repository to your forked repository.
   • Set the compare branch to your branch (your-branch-name).
4. Fill out the PR form with a clear title and description of your changes.
5. Click Create Pull Request.

⏳ Await Review

Once your PR is submitted, the maintainers will review your changes. They may provide feedback or request additional changes. During this process:

• Monitor Your PR: Keep an eye on GitHub notifications for any comments or requests
• Be Responsive: Try to address feedback promptly and professionally
• Make Updates: If changes are requested, update your branch and push the new commits
• Ask Questions: Don't hesitate to ask for clarification if needed
• Be Patient: The review process may take some time depending on maintainer availability

Remember that code review is a collaborative process aimed at ensuring code quality. Stay engaged and maintain open communication with the maintainers throughout the review process.

💡 Contribution Tips

To ensure your contribution is accepted, follow these tips:

• Use Conventional Commits: Write clear and consistent commit messages using the Conventional Commits format.
• Keep Your PRs Small: Focus on one issue or feature per PR to make it easier to review.
• Be Patient: Maintainers are often volunteers and may take some time to review your PR.
• Write Tests: Include tests for any new features or bug fixes you implement.
• Follow Code Style: Adhere to the project's coding standards and style guidelines.
• Update Documentation: Keep documentation in sync with code changes.
• Engage in Discussion: Participate in PR discussions and be open to feedback.
• Review Others' PRs: Help the community by reviewing other contributors' pull requests.
• Stay Updated: Keep your fork synchronized with the main repository.

⭐ Why Contribute?

Contributing to open-source projects like Palmr has many benefits:

1. Improves the Project: Your contributions help make the project better for everyone.
2. Builds Your Skills: You’ll gain experience working with Git, GitHub, and collaborative coding.
3. Supports the Community: Open-source thrives on community contributions. Your work helps sustain the project.

🎉 Final Words

That's it! You've successfully contributed to the 🌴 Palmr. project on GitHub. Thank you for your time and effort in making Palmr better for everyone. We appreciate your contribution!