Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: write an end-to-end contribution flow #750

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 28 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,34 @@ Theses are just some examples of the hidden costs that are not so apparent from

* Do not open an issue on GitHub until you have collected positive feedback about the change. GitHub issues are primarily intended for bug reports and fixes.


#### **How can i create my first contribution ?**

- **Find an Issue:**
Start by finding an issue to work on. You can either create a new GitHub issue or pick one that has been assigned to you.

- **Create a Branch:**
Create a new branch for your work. Use a descriptive name that reflects the issue or feature you're addressing (e.g., fix/login-bug or add/feature-x).

- **Make Changes:**
Write or fix the code in your branch. Ensure your changes align with the project's coding standards and guidelines.

- **Push Changes:**
Once your changes are ready, push your branch to GitHub.

- **Open a Pull Request (PR):**
Create a pull request (PR) from your branch. Include a clear and concise description of your changes, explaining what the PR does and why it’s needed. Make sure to reference the related issue (e.g., "Fixes #123").
Note: At least two reviewers are required to approve the PR before it can be merged.

- **Review Process:**
Team members will review your code, provide feedback, and suggest improvements. Be open to constructive criticism and ready to iterate on your work.

- **Address Feedback:**
Make any necessary changes based on the feedback. Once you’ve addressed the comments, tag the reviewers to let them know your updates are ready for another review.

- **Merge:**
Once your PR is approved by at least two reviewers, it will be merged into the main project. Congratulations, your code is now part of the project!

#### **Do you have questions about the source code?**

* Ask any question about how to use Hexabot in our [Discord Channel](https://discord.gg/rNb9t2MFkG).
Expand Down