Skip to content

Contributing

Dmytro Katashev edited this page Aug 12, 2024 · 1 revision

Contributing to SFCC Web Service Library

Thank you for considering contributing to the SFCC Web Service Library! Your contributions help make this project better for everyone. Whether youโ€™re reporting bugs, suggesting enhancements, or contributing code, every bit of help is appreciated.

How to Contribute

1. Reporting Bugs

If you find a bug, please report it by opening an issue on our GitHub repository. When reporting a bug, please include:

  • A clear and descriptive title.
  • A detailed description of the problem, including steps to reproduce the issue.
  • Any relevant screenshots or code snippets.
  • Information about your environment (e.g., operating system, SFCC version).

2. Suggesting Enhancements

If you have an idea for a new feature or an improvement to an existing feature, weโ€™d love to hear from you. Please open an issue and include:

  • A clear and descriptive title.
  • A detailed explanation of your suggestion, including any use cases or examples.
  • Why you believe this enhancement would be beneficial to the project.

3. Contributing Code

If youโ€™d like to contribute code, please follow these steps:

Fork the Repository

  1. Go to the repository on GitHub and click the "Fork" button in the top right corner.

Clone Your Fork

  1. Clone your forked repository to your local machine:
    git clone https://github.com/your-username/sfcc-web-services.git

Create a Branch

  1. Create a new branch for your work:
    git checkout -b feature/your-feature-name

Make Your Changes

  1. Make your changes to the codebase. Ensure that your code follows the existing style and includes any necessary documentation.

Write Tests

  1. If your contribution involves code, please write tests to ensure that your changes work as expected and do not break existing functionality.

Commit Your Changes

  1. Commit your changes with a descriptive commit message:
    git commit -m "Add feature: your-feature-name"

Push to Your Fork

  1. Push your changes to your fork on GitHub:
    git push origin feature/your-feature-name

Submit a Pull Request

  1. Go to the original repository and submit a pull request from your fork. Please include a clear description of the changes and any relevant information.

4. Code of Conduct

Please note that all contributors are expected to adhere to our Code of Conduct. This ensures that our community remains welcoming and inclusive for everyone.

5. Documentation Contributions

If youโ€™d like to contribute to the projectโ€™s documentation (including the Wiki), you can either edit the Wiki directly (if allowed) or submit a pull request with your changes.

6. Need Help?

If you have any questions about contributing, feel free to open an issue or reach out via the repositoryโ€™s discussion forum. Weโ€™re here to help!

Clone this wiki locally