Skip to content

Latest commit

 

History

History
57 lines (40 loc) · 2.75 KB

CONTRIBUTING.md

File metadata and controls

57 lines (40 loc) · 2.75 KB
Raw

Contributing to UsefulDay

Thank you for considering contributing to UsefulDay! We welcome contributions of all kinds, from bug fixes and improvements to new features and documentation updates. Please follow the guidelines below to help us maintain the quality and consistency of the project.

How to Contribute

Reporting Issues

If you encounter any bugs or have suggestions for improvements, please open an issue on our GitHub Issues page. When reporting an issue, provide as much detail as possible, including:

  • A description of the problem or suggestion
  • Steps to reproduce the issue (if applicable)
  • Any relevant screenshots or error messages

Submitting Code

We use GitHub for version control, so please follow these steps to contribute code:

  1. Fork the Repository: Click the "Fork" button at the top right of the repository page to create a copy of the repository in your own GitHub account.

  2. Clone Your Fork: Clone your fork to your local machine:

    git clone https://github.com/YOUR_USERNAME/usefulday.git

  3. Create a Branch: Create a new branch for your changes. Use a descriptive name for your branch or issue_<number>:

    git checkout -b my-feature-branch

  4. Make Your Changes: Implement your changes on your branch. Be sure to follow our coding style and guidelines (see below).

  5. Write Tests: If applicable, write tests for your changes to ensure they work correctly and don’t introduce new issues.

  6. Commit Your Changes: Commit your changes with a clear and descriptive commit message:

    git add .
git commit -m "Add feature X to improve Y"

  7. Push Your Changes: Push your branch to your fork:

    git push origin my-feature-branch

  8. Create a Pull Request: Open a pull request from your branch to the main branch of the original repository. Provide a clear description of your changes and why they are needed.

Coding Style

  • Code Formatting: Follow the existing code formatting and style. Consistency is key for readability.
  • Documentation: Update documentation as necessary to reflect your changes.
  • Testing: Ensure your changes are covered by tests and all tests pass before submitting your pull request.

Review Process

  • Code Review: All pull requests will be reviewed by the maintainers. Feedback and suggestions will be provided to help you improve your contribution.
  • Merging: Once your pull request has been reviewed and approved, it will be merged into the main branch.

Contributor License Agreement

By contributing to this project, you agree to grant us a license to use, modify, and distribute your contribution under the project’s license terms.