Skip to content

Latest commit

 

History

History
69 lines (45 loc) · 2.89 KB

CONTRIBUTING.md

File metadata and controls

69 lines (45 loc) · 2.89 KB
Raw

Contributing to CSCI240 C++ Utility Library

First off, thank you for considering contributing to the CSCI240 C++ Utility Library! We appreciate your effort and contribution to making this project a valuable resource for everyone.

Table of Contents

How Can I Contribute?

Reporting Bugs

If you encounter any bugs or issues, please create a new issue in the GitHub repository with the following details:

  • A clear and descriptive title.
  • A clear and concise description of the issue.
  • Steps to reproduce the problem.

Suggesting Enhancements

We welcome suggestions for improvements and new features:

  • Provide a clear and descriptive title.
  • Explain why this enhancement would be useful to most users and how it benefits the project.

Pull Requests

If you wish to contribute code, documentation, or any other assets, please follow these steps:

  1. Fork the Repository: Create a fork of the repository to your own GitHub account.
  2. Clone the Repository: Clone the forked repository to your local machine.
  3. Create a Branch: Make a new branch for your feature or bugfix (e.g. git checkout -b yourname_issuenumber_desc).
  4. Make Changes: Implement your changes, additions, or fixes.
  5. Push Changes: Push your changes to your fork on GitHub.
  6. Submit a Pull Request: Create a new pull request from your fork to the main repository.

Please adhere to the following principles:

  • Ensure that your code follows the styleguides.
  • Write good commit messages that effectively communicate the changes and rationale.
  • If your pull request addresses an existing issue, please reference it in your commit message.

Styleguides

Git Commit Messages

  • Use the present tense ("Add feature" not "Added feature").
  • Limit the first line to 72 characters or fewer.
  • Reference issues and pull requests when appropriate.

C++ Styleguide

  • Write clear, readable, and concise code.
  • Comment your code adequately to explain your logic and reasoning.
  • Follow best practices for C++ programming and adhere to established coding conventions in the project.

Acknowledgments

  • Please ensure that you acknowledge the work of others if you used their code as a reference or building block.
  • Adhere to the licensing terms and conditions of this project and third-party libraries or tools used.

Questions?

If you have any questions or need further clarification, please don't hesitate to reach out via email - rajaali@iu.edu