Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
67 lines (48 loc) · 2.29 KB

CONTRIBUTING.md

File metadata and controls

67 lines (48 loc) · 2.29 KB

Contributing to RollAsBack

Welcome to RollAsBack! We appreciate your interest in contributing to this project. Whether you're fixing a bug, improving an existing feature, or adding a new one, your contribution is valuable.

Getting Started

Before you start contributing, please ensure you have read the README file to understand the project structure and how to use RollAsBack.

How to Contribute

  1. Fork the Repository:

  2. Clone Your Fork:

    • Clone your forked repository to your local machine. 
      git clone https://github.com/your-username/rollasback.git

  3. Create a Branch:

    • Create a new branch for your contribution. 
      git checkout -b feature/my-feature

  4. Make Changes:

    • Make your changes to the codebase. Ensure that your changes follow the project's coding conventions.

  5. Run Tests:

    • Before submitting a pull request, run the tests to ensure that your changes do not break existing functionality.

  6. Commit Changes:

    • Commit your changes with a meaningful commit message. 
      git commit -m "Add new feature"

  7. Push Changes:

    • Push your changes to your fork on GitHub. 
      git push origin feature/my-feature

  8. Create a Pull Request:

    • Go to your fork on GitHub and open a pull request.
    • Provide a detailed description of your changes and why they are necessary.

Code Review

Your pull request will be reviewed by the project maintainers. During the review process, you may be asked to make additional changes. Once your pull request is approved, it will be merged into the main branch.

Reporting Issues

If you encounter bugs or have suggestions for improvements, please open an issue on GitHub. Provide detailed information about the issue or your suggestion.

Code of Conduct

Please note that RollAsBack has a Code of Conduct. By participating in this project, you agree to abide by its terms.

Thank you for contributing to RollAsBack! Your efforts help make this project better for everyone.