Skip to content

Latest commit

 

History

History
40 lines (24 loc) · 2.29 KB

CONTRIBUTING.md

File metadata and controls

40 lines (24 loc) · 2.29 KB
Raw

Contributing to AKOS

Thank you for your interest in contributing to AKOS! This guide provides an overview of how to successfully contribute.

How to Contribute

Reporting Issues

If you find a bug or have a suggestion for enhancing AKOS, please begin by checking our issue tracker to see if someone else has already reported the issue. If it's a new issue, please open a new issue and provide as much detail as you can. Include steps to reproduce the bug, or describe the enhancement you're proposing with as much clarity as possible.

Making Contributions

If you'd like to contribute directly to the project's code or documentation, please follow these steps:

  1. Fork the Repository
    Start by forking the AKOS repository to your GitHub account.

  2. Create a Branch
    Create a branch in your fork for your contribution. Give it a meaningful name that reflects the changes you intend to make.

  3. Make Your Changes
    With your branch created, you're ready to make your changes. Feel free to update existing documentation, fix bugs, or add new features that align with the project's goals.

  4. Submit a Pull Request
    After you've made your changes, submit a pull request (PR) against the main AKOS repository. Please provide a clear description of the problem you're solving or the enhancement you're introducing. Include any relevant issue numbers.

  5. Review Process
    Once your PR is submitted, the project maintainers will review your contributions. There might be a discussion or requests for changes. We aim to respond to PRs as quickly as possible.

Pull Request Guidelines

  • Ensure your code follows any coding standards and conventions already established in the project.
  • Write meaningful commit messages that provide insight into the changes you've made.
  • Update the README.md or any relevant documentation to reflect your changes or additions.

Questions or Suggestions?

If you have questions or suggestions, feel free to open an issue for general discussion. We're always looking for ways to improve AKOS and appreciate all the feedback we get.

Thank you for your interest in contributing to AKOS, and we look forward to your contributions!