Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
74 lines (52 loc) · 3.15 KB

CONTRIBUTING.md

File metadata and controls

74 lines (52 loc) · 3.15 KB

Contributing to WriteMe

Thank you for your interest in contributing to WriteMe! This document outlines the process for contributing to our project. Please follow these guidelines to help us review your changes as quickly as possible.

Table of Contents

  1. Code of Conduct
  2. Getting Started
  3. How to Contribute
  4. Style Guide
  5. Testing
  6. Pull Request Process
  7. Acknowledgements

Code of Conduct

By participating in this project, you agree to abide by our Code of Conduct. Please read it to understand the expectations for our community.

Getting Started

  1. Fork the repository: Click the "Fork" button at the top right of the repository page to create a copy of the repository under your GitHub account.
  2. Clone the repository: Use git clone https://github.com/COS301-SE-2024/WriteMe.git to clone the repository to your local machine.
  3. Create a branch: Create a new branch for your work using git checkout -b your-branch-name.

How to Contribute

Reporting Bugs

If you find a bug, please create an issue on GitHub with the following information:

  • A short, descriptive title
  • A detailed description of the issue
  • Steps to reproduce the issue
  • Any relevant logs or screenshots

Suggesting Enhancements

If you have an idea to enhance the project, please open an issue with:

  • A clear and descriptive title
  • A detailed description of your suggestion
  • Any relevant supporting information

Submitting Code

  1. Ensure your code follows the project's coding standards and passes all tests.
  2. Create a branch: Use a descriptive branch name that clearly identifies the work being done.
  3. Make your changes: Commit your changes with clear and concise commit messages.
  4. Push to your fork: git push origin your-branch-name.
  5. Create a Pull Request: Go to the original repository and click the "New Pull Request" button. Follow the template provided.

Style Guide

Please ensure your code adheres to the following style guide:

  • Use meaningful variable and function names.
  • Write comments to explain complex logic.
  • Follow the PEP 8 style guide for Python code.
  • Follow this guide for all other code.
  • Maintain consistent indentation and formatting.

Testing

Before submitting your code, ensure it passes all tests:

  1. Write tests: Add tests for any new features or bug fixes.
  2. Run tests: Use the project's testing framework to run all tests.
  3. Verify: Ensure all tests pass and your code coverage is maintained or improved.

Pull Request Process

  1. Review: Your pull request will be reviewed by the project maintainers. They may request changes or provide feedback.
  2. Update: Make any requested changes and push to your branch.
  3. Merge: Once approved, your changes will be merged into the main branch.

Acknowledgements

We appreciate all contributions, whether they're issues, suggestions, or code changes. Thank you for helping us improve WriteMe!