Contributing to Galbe

First off, thank you for considering contributing to our project! We appreciate your time and effort and want to make this as easy and transparent as possible for everyone.

Create an Issue

If you encounter a bug, want to propose a new feature, or have an idea for improvement, please create an issue. Here's how:

1. Check Existing Issues: Before creating a new issue, please search the existing issues to see if someone else has already reported the same problem or suggested the same feature.

2. Open a New Issue: If your issue is new, open a new issue and provide the following details:

   • Title: A concise summary of the issue.
   • Description: A detailed description of the problem or suggestion. Include steps to reproduce the issue if applicable.
   • Screenshots: If possible, include screenshots or other visual aids that help explain the issue.
   • Environment: Mention the environment in which you encountered the issue (e.g., OS, Bun version).
   • Labels: Assign appropriate labels (e.g., bug, enhancement) to help categorize your issue.

3. Follow Up: Once your issue is submitted, be ready to provide additional information if requested. We'll do our best to address the issue promptly.

Create a Pull Request

1. Fork the Repository

If you haven't already, fork Galbe's repository on GitHub. This will create a copy of this repository under your GitHub account.

2. Clone Your Fork

Clone the forked repository to your local machine:

git clone https://github.com/<your-username>/galbe.git

cd galbe

3. Create a New Branch

Before making any changes, create a new branch for your work. Branches help keep your changes separate from the main branch and make it easier to review and merge:

git checkout -b feature/your-feature-name

Use a descriptive name for your branch to indicate what you are working on.

4. Make Your Changes

Make the necessary changes in your branch. Be sure to follow the project's coding style and best practices.

5. Commit Your Changes

Once you’ve made your changes, commit them with a clear and descriptive message:

git add .

git commit -m "Add feature X to do Y"

6. Push to Your Fork

Push your changes to your forked repository on GitHub:

git push origin feature/your-feature-name

7. Create a Pull Request

Once your changes are pushed to GitHub, you can create a pull request. Go to the original repository on GitHub, and you should see an option to create a pull request from your branch.

• Make sure to provide a detailed description of your changes and why they are necessary.
• Link any related issues if applicable.
• If your pull request is still a work in progress, mark it as a draft to let others know that you are not yet ready for a review.

8. Respond to Feedback

Once your pull request is submitted, it will be reviewed by the project maintainers. They may ask for changes or provide feedback. Please be responsive and make the necessary adjustments.

Coding Standards

Please follow these coding standards to ensure consistency across the project:

• Code Style: Follow the project's existing code style.
• Commit Messages: Use clear and descriptive commit messages.
• Documentation: Update documentation where applicable. This includes comments in the code and other documentation files under the docs directory.

Code of Conduct

We are committed to creating a welcoming and inclusive environment for everyone. To ensure this, all contributors are expected to adhere to the following guidelines:

1. Be Respectful: Treat everyone with respect. Disagreements are inevitable, but it's important to remain courteous and constructive. Personal attacks, harassment, or offensive comments will not be tolerated.

2. Collaborate Openly: Collaboration is key to the success of the project. Be open to feedback and suggestions from others. Constructive criticism should be welcomed and given in a positive manner.

3. Resolve Disagreements Constructively: If you find yourself in a disagreement, seek to resolve it in a way that is constructive and respectful. If necessary, involve a project maintainer to help mediate.

4. Report Issues: If you witness or experience any behavior that violates this Code of Conduct, please report it immediately to the project maintainers. We take all reports seriously and will address them promptly.

By participating in this project, you agree to abide by this Code of Conduct.

Getting Help

If you have any questions or need help, feel free to open an issue or contact one of the maintainers.

Thank you for your contribution!