Octoflow

Official website for the perfect tool to keep you connected to your GitHub activity and stay up-to-date with every commit.

---

Contributing

We welcome contributions to Octoflow! Whether you're fixing a bug, adding a new feature, or improving documentation, your help is appreciated. Follow these steps to contribute:

Getting Started

1. Fork the Repository: Click the "Fork" button at the top right of the repository page to create a copy of the repository in your GitHub account.

2. Clone Your Fork: Clone your forked repository to your local machine.

   git clone https://github.com/username_or_org/Website
   cd octoflow

3. Create a Branch: Create a new branch to commit your changes to.

git checkout -b feature/your-feature-name

Making Changes

1. **Install Dependencies: Install the necessary dependencies

bun install

2. Make Your Changes: Implement your changes in the codebase. Ensure your code follows the project's coding standards and conventions.

• Docs content can be found in content/docs
• Blog content can be found in content/blog
• The next.js app can be found at app

3. Commit Your Changes: Commit your changes with a descriptive commit message.

git commit -m "feat(add): your_feature_description"

4. **Push Your Changes: Push your changes to your forked repository

git push origin master feature/your-feature-name

Submitting your Contribution

1. Open a Pull Request: Go to github.com/Git-Logs/Website and open a pull request from your forked repository. Provide a clear and descriptive title and description for your changes/pull request.

2. Review Process: Your pull request will be reviewed by the maintainers. They may request changes or provide feedback. Please be responsive and reasonable to their comments and make any necessary updates.

3. Merge: Once your pull request is approved, it will be merged into the dev branch and put in rotation for the next release. Congratulations you've contributed to Octoflow!

Guidelines

• Code Style: Follow the existing code style and conventions. Use consistent indentation, naming conventions, and formatting.
• Commit Messages: Write clear and concise commit messages that describe the changes made.

Reporting Issues

If you encounter any issues or bugs, please report them by opening a issue in the repository. Provide as much detail as possible, including steps to reproduce the issue, expected behavior, and any relevant screenshots or logs.

Additionally you can join our Discord Server for support.

Thank you for contributing to the Octoflow Website! Your help is greatly appreciated.