Skip to content

Latest commit

 

History

History
80 lines (52 loc) · 2.39 KB

CONTRIBUTING.md

File metadata and controls

80 lines (52 loc) · 2.39 KB

Contributing to acreom

Thank you for considering contributing to acreom!

How to Contribute

Reporting Bugs

If you find a bug, please report it by opening an issue on our GitHub Issues page. Include the following details:

  • A clear and descriptive title
  • A detailed description of the problem
  • Steps to reproduce the issue
  • Any error messages you received

Suggesting Enhancements

We welcome suggestions for new features or enhancements. To suggest an idea, please open an issue on our GitHub Issues page. Include the following details:

  • A clear and descriptive title
  • A detailed description of the proposed enhancement
  • Any related information or context

Your First Contribution

If you're new to open source and unsure where to start, you can look for issues labeled good first issue. These are simpler tasks that are great for new contributors.

Making Changes

  1. Fork the Repository

    Fork the Repository by clicking the "Fork" button in the top right corner of the repository page.

  2. Clone the Repository

    git clone https://github.com/acreom/acreom.git
cd acreom

  3. Create a Branch

    Create a new branch for your changes:

    git checkout -b feature-branch-name

  4. Make Your Changes

    Make your changes to the codebase. Ensure your code adheres to our coding standards and passes all tests.

  5. Commit Your Changes

    Write clear and descriptive commit messages. Reference any issues related to the changes.

    git commit -m 'Add description of your changes'

  6. Push Your Changes

    Push your changes to your forked repository:

    git push origin feature-branch-name

  7. Submit a Pull Request

    Go to the acreom repository and submit a pull request. Provide a clear description of your changes and any additional context or information that will help the maintainers review your contribution.

Code Style and Standards

Follow the coding style used in the project. Ensure your code passes all tests before submitting a pull request. Write unit tests for new features and bug fixes.

Community Guidelines

Be respectful and considerate in your interactions.

Getting Help

If you need help or have any questions, feel free to open an issue on our GitHub Issues page or join our community on discord.

Thank you for contributing!