Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
60 lines (35 loc) · 2.48 KB

CONTRIBUTING.md

File metadata and controls

60 lines (35 loc) · 2.48 KB

Contributing to Oxy

Thank you for your interest in contributing to Oxy! We welcome contributions from the community and are excited to work with you.

How to Contribute

Reporting Issues

If you encounter any issues or bugs, please report them by creating a new issue in the GitHub Issues section. Provide as much detail as possible, including steps to reproduce the issue and any relevant logs or screenshots.

Feature Requests

We are always looking to improve Oxy. If you have a feature request, please open a new issue in the GitHub Issues section and label it as a feature request. Describe the feature in detail and explain why it would be beneficial.

Code Contributions

  1. Fork the Repository: Fork the Oxy repository to your GitHub account.

  2. Clone the Repository: Clone your forked repository to your local machine.

    git clone https://github.com/<your-username>/oxy.git
cd oxy

  3. Create a Branch: Create a new branch for your feature or bugfix.

    git checkout -b feature/your-feature-name

  4. Make Changes: Make your changes to the codebase. Ensure that your code follows the project's coding standards and includes appropriate tests.

  5. Commit Changes: Commit your changes with a clear and concise commit message following the Conventional Commits specification.

    git commit -m "feat: add feature description"

  6. Push Changes: Push your changes to your forked repository.

    git push origin feature/your-feature-name

  7. Create a Pull Request: Open a pull request from your branch to the main branch of the original repository. Provide a detailed description of your changes and any relevant information.

Code Style

Please ensure that your code adheres to the project's coding standards. This includes proper formatting, naming conventions, and documentation.

Testing

Ensure that your changes are covered by tests. Run the existing tests to make sure that your changes do not break any existing functionality.

Documentation

If your contribution includes changes to the functionality, please update the relevant documentation in the README.md or other appropriate documentation files. Refer to the DEVELOPMENT.md file for detailed development instructions.

Thank you for contributing to Oxy!