Skip to content

Latest commit

 

History

History
62 lines (35 loc) · 2.78 KB

CONTRIBUTING.md

File metadata and controls

62 lines (35 loc) · 2.78 KB
Raw

Contributing to InfraBoard

We are excited that you are interested in contributing to InfraBoard! This document provides guidelines for contributions to the project.

How to Contribute

Contributions to InfraBoard can take many forms. Here are some ways you can help:

  • Reporting Bugs: If you find a bug, please create an issue in our issue tracker.
  • Suggesting Enhancements: Have ideas on how to make InfraBoard better? Open an issue with your suggestion.
  • Code Contributions: If you want to write code for InfraBoard, that's great! Start by looking at our open issues.

Steps for Contributing

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

  2. Clone the Forked Repository: Clone your fork to your local machine.

  3. Create a New Branch: Create a branch for your contribution (git checkout -b feature/YourFeature).

  4. Make Your Changes: Work on the changes you wish to make.

  5. Test Your Changes: Ensure your changes do not introduce any new bugs or issues.

  6. Commit Your Changes: Commit your changes with a clear commit message (git commit -m 'Add YourFeature').

  7. Push to Your Branch: Push your changes to your branch (git push origin feature/YourFeature).

  8. Open a Pull Request: Go to the InfraBoard repository and open a pull request from your branch.

Notes :

To contribute to InfraBoard, always push new features or bug fixes to a feature/bug branch first. Then, raise a pull request (PR) from your feature/bug branch to the test branch for review. It's crucial to target the test branch with your PRs to ensure changes are tested before merging into the master/stage codebase. This approach helps maintain the stability and quality of the project.

Coding Guidelines

  • Ensure your code adheres to the project's coding standards.
  • Write clean, readable, and maintainable code.
  • Include comments in your code where necessary.

Documentation

If you are adding new features or making changes that require documentation updates, please include them in your pull requests.

Pull Request Guidelines

  • Keep pull requests concise and focused on a single issue or feature.
  • Provide a detailed description of your changes in the pull request.
  • Reference any relevant issue numbers in your pull request description.

Code of Conduct

Please note that this project is released with a Contributor Code of Conduct. By participating in this project, you agree to abide by its terms.

Questions?

If you have any questions or need assistance, feel free to open an issue for discussion.

Thank you for contributing to InfraBoard, and we look forward to your contributions!