You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
We warmly welcome contributions to the raylib-go project! Whether you're
fixing bugs, adding new features, or improving documentation, your help is
greatly appreciated. This document provides guidelines to make your
contribution experience smooth and efficient.
Getting Started
Step 1: Fork the Repository
Fork the raylib-go repository to your GitHub account.
This creates your own copy of the project where you can make changes.
Step 2: Clone Your Fork
Clone your fork to your local machine. Replace your-username with your
GitHub username.
git clone https://github.com/your-username/raylib-go.git
cd raylib-go
Making Changes
Choose an Issue
Start by looking at the issues in the main repository.
Pick one that interests you or submit a new issue if you have an idea or have found a bug.
It's best to discuss new features or significant changes before starting work.
Create a New Branch
Create a new branch for your changes. This keeps your work organized and
makes it easier to manage multiple contributions.
git checkout -b your-branch-name
Write Code
Keep your changes as simple and modular as possible. This helps respect the
maintainers time as well as make it easier to coordinate issues to pull requests.
Testing Your Changes
Ensure your changes do not break existing functionality. Test your changes
in different environments and scenarios related to your work.
Submitting Your Changes
Step 1: Commit Your Changes
Once you're satisfied with your changes, commit them to your branch. Write
clear and concise commit messages. Effective commit messages are crucial for
project history. Here's how to craft them well:
Header Line
Summarize the change in one line using the imperative mood.
Keep it concise and meaningful.
This line appears in summaries and logs, so make it informative.
Commit Message Body
Explain the change in detail. The body can have multiple paragraphs.
Focus on why the change is necessary rather than what you changed.
Keep lines shorter than 74 characters for readability in Git tools.
Use proper word-wrap and indentation.
git add .
git commit -a
Step 2: Push to Your Fork
Push your changes to your fork on GitHub.
git push origin your-branch-name
Step 3: Create a Pull Request
Go to the original raylib-go repository and create a pull request from your
fork. Provide a detailed description of your changes and the issue it
addresses.
Code Review Process
Your pull request will be reviewed by the maintainers. Be open to feedback
and make necessary revisions. Once approved, your changes will be merged
into the main codebase.
Stay Updated
Regularly pull changes from the main repository to keep your fork up to date.
This helps avoid merge conflicts.
reacted with thumbs up emoji reacted with thumbs down emoji reacted with laugh emoji reacted with hooray emoji reacted with confused emoji reacted with heart emoji reacted with rocket emoji reacted with eyes emoji
-
Contributing to raylib-go
We warmly welcome contributions to the raylib-go project! Whether you're
fixing bugs, adding new features, or improving documentation, your help is
greatly appreciated. This document provides guidelines to make your
contribution experience smooth and efficient.
Getting Started
Step 1: Fork the Repository
Fork the raylib-go repository to your GitHub account.
This creates your own copy of the project where you can make changes.
Step 2: Clone Your Fork
Clone your fork to your local machine. Replace
your-username
with yourGitHub username.
git clone https://github.com/your-username/raylib-go.git cd raylib-go
Making Changes
Choose an Issue
Start by looking at the issues in the main repository.
Pick one that interests you or submit a new issue if you have an idea or have found a bug.
It's best to discuss new features or significant changes before starting work.
Create a New Branch
Create a new branch for your changes. This keeps your work organized and
makes it easier to manage multiple contributions.
Write Code
Keep your changes as simple and modular as possible. This helps respect the
maintainers time as well as make it easier to coordinate issues to pull requests.
Testing Your Changes
Ensure your changes do not break existing functionality. Test your changes
in different environments and scenarios related to your work.
Submitting Your Changes
Step 1: Commit Your Changes
Once you're satisfied with your changes, commit them to your branch. Write
clear and concise commit messages. Effective commit messages are crucial for
project history. Here's how to craft them well:
Header Line
Commit Message Body
git add . git commit -a
Step 2: Push to Your Fork
Push your changes to your fork on GitHub.
Step 3: Create a Pull Request
Go to the original raylib-go repository and create a pull request from your
fork. Provide a detailed description of your changes and the issue it
addresses.
Code Review Process
Your pull request will be reviewed by the maintainers. Be open to feedback
and make necessary revisions. Once approved, your changes will be merged
into the main codebase.
Stay Updated
Regularly pull changes from the main repository to keep your fork up to date.
This helps avoid merge conflicts.
Community Guidelines
Further Assistance
If you need help or have questions, feel free to ask on the issues page.
Thank you for contributing to raylib-go, and happy coding!
Beta Was this translation helpful? Give feedback.
All reactions