Skip to content
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
76 changes: 76 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
# Contributing to AlphaRages 🚀

Hi there! We're thrilled that you're interested in contributing to our projects. The time and effort from community contributors are greatly valued and help us grow and improve.

This document is a guide to help you make your contribution as smooth as possible.

## Code of Conduct

First and foremost, we expect all community members to abide by our [Code of Conduct](LINK_TO_CODE_OF_CONDUCT). Please make sure you are welcoming and respectful in all of our interactions. (Note: If this file does not exist yet, you can remove this section or leave it as a reminder to create one).

## How Can You Contribute?

There are many ways to contribute, not just with code!

* **Reporting Bugs:** If you find an error, please let us know.
* **Suggesting Enhancements:** Have an idea for a new feature or an improvement to an existing one? We'd love to hear it.
* **Writing Documentation:** Documentation can always be improved.
* **Contributing Code:** Helping to fix bugs or implement new features.

## Reporting a Bug

If you've found a bug, please open an **Issue** in the corresponding project repository. To help us resolve the problem quickly, please include as many details as possible:

1. **Describe the bug:** What happened, and what did you expect to happen?
2. **Steps to Reproduce:** A step-by-step guide on how we can encounter the same error.
3. **Environment:** What operating system, project version, and Node.js/Flutter/etc. version are you using?
4. **Logs or Screenshots:** If possible, attach any relevant error logs or screenshots.

## Suggesting an Enhancement

To suggest an enhancement, please open an **Issue** with the following information:

1. **A clear title:** E.g., "Enhancement: Add Google Sign-In option".
2. **Describe the problem:** What problem does your suggestion solve? Why would it be useful?
3. **Proposed solution:** Describe how you imagine the feature working.

## Your First Code Contribution

Ready to write some code? Great! Here is the workflow we use:

1. **Claim an Issue:** Find an issue you want to resolve and comment on it to let us know you'd like to work on it. Please wait for a maintainer to give you the "go-ahead" before you start. This prevents duplicated work.

2. **Fork the Repository:** Create a fork of the repository to your own GitHub account.

3. **Clone Your Fork:** Download your fork to your local machine.
```bash
git clone [https://github.com/YOUR-USERNAME/REPOSITORY-NAME.git](https://github.com/YOUR-USERNAME/REPOSITORY-NAME.git)
```

4. **Create a Branch:** Never work directly on the `main` branch. Create a new branch for your changes with a descriptive name.
```bash
# For a new feature
git checkout -b feat/feature-name

# For a bug fix
git checkout -b fix/bug-description
```

5. **Make Your Changes:** Write the code, fix the bug, or improve the documentation.

6. **Commit Your Changes:** Add your changes and create a commit with a clear message, following the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) standard.
```bash
git add .
git commit -m "feat: Add Google Sign-In functionality"
```

7. **Push to Your Fork:** Push your branch with your changes to your repository on GitHub.
```bash
git push origin feat/feature-name
```

8. **Open a Pull Request (PR):** Go to the original repository's page, and you will see a prompt to create a Pull Request from your new branch. Fill out the PR template with a clear description of what you've done.

That's it! One of the maintainers will review your work, might ask for some changes, and then merge it into the project.

Thank you again for your contribution! ❤️