Skip to content

Latest commit

 

History

History
62 lines (43 loc) · 2.93 KB

CONTRIBUTING.md

File metadata and controls

62 lines (43 loc) · 2.93 KB

Contributing to the Project

Thank you for your interest in contributing to this project! We appreciate your help in improving and expanding our work. Please follow these guidelines to make the contribution process smooth and efficient.

How to Contribute

Reporting Issues

If you find a bug or have a feature request, please follow these steps:

  1. Check Existing Issues: Before creating a new issue, check the existing ones to see if the problem or feature request has already been reported.
  2. Create a New Issue: If your issue or request is not listed, create a new issue using the GitHub Issues page. Provide a clear and descriptive title and include any relevant information or steps to reproduce the problem.

Submitting Changes

To submit changes to the project, follow these steps:

  1. Fork the Repository: Start by forking the repository to your own GitHub account.
  2. Clone Your Fork: Clone the forked repository to your local machine.
   git clone https://github.com/francisjgarcia/straperr.git
  1. Create a New Branch: Create a new branch for your changes.
git checkout -b your-branch-name
  1. Make Your Changes: Implement your changes according to our Coding Style Guide.
  2. Commit Your Changes: Commit your changes with a descriptive commit message.
git add .
git commit -m "Add a descriptive commit message"
  1. Push Your Changes: Push your branch to your forked repository.
git push origin your-branch-name
  1. Open a Pull Request: Go to the original repository and open a pull request from your branch. Provide a clear description of your changes and why they are being made.

Coding Style Guide

Please follow our Coding Style Guide when making changes to ensure consistency in the codebase. This guide includes rules for indentation, line endings, and formatting tools.

Code Review Process

  • Review: All pull requests will be reviewed by project maintainers. They may suggest changes or request additional information.
  • Feedback: Respond to feedback promptly and make necessary adjustments. This helps to expedite the review process and integrate your changes more quickly.

Testing

  • Write Tests: Ensure that your changes include appropriate tests. Follow the testing guidelines and frameworks used in this project.
  • Run Tests: Before submitting a pull request, run all tests to ensure that your changes do not break existing functionality.

Contribution Guidelines

  • Be Respectful: Communicate respectfully and professionally with other contributors and maintainers.
  • Follow Project Policies: Adhere to any additional guidelines or policies outlined in the repository.

Questions?

If you have any questions or need further assistance, feel free to reach out through the project's Discussions.

Thank you for contributing to this project!