Skip to content

Latest commit

 

History

History
66 lines (49 loc) · 2.12 KB

CONTRIBUTING.md

File metadata and controls

66 lines (49 loc) · 2.12 KB

Contributing to Dictionary API Client

Thank you for considering contributing to the Dictionary API Client project! We appreciate your time and effort in helping us improve this project. Please follow the guidelines below to ensure a smooth contribution process.

How to Contribute

Fork the Repository

  1. Go to the repository page.
  2. Click the "Fork" button in the top right corner of the page.
  3. This will create a copy of the repository in your GitHub account.

Create a New Branch

  1. Clone the forked repository to your local machine: 
    git clone https://github.com/your-username/dictionary-api-client
cd dictionary-api-client
  2. Create a new branch for your changes: 
    git checkout -b your-branch-name

Make Changes and Commit Them

  1. Make the necessary changes to the codebase.
  2. Stage the changes: 
    git add .
  3. Commit the changes with a descriptive message: 
    git commit -m "Description of the changes"

Push Changes to a Remote Branch

  1. Push the changes to your forked repository: 
    git push origin your-branch-name

Create a Pull Request

  1. Go to the original repository page.
  2. Click the "New Pull Request" button.
  3. Select the branch you created and compare it with the main branch.
  4. Provide a descriptive title and detailed description of your changes.
  5. Click "Create Pull Request" to submit your contribution.

Coding Standards and Best Practices

  • Follow the existing code style and conventions.
  • Write clear and concise commit messages.
  • Ensure your code is well-documented and includes comments where necessary.
  • Write tests for any new features or bug fixes.
  • Run the existing tests to ensure your changes do not break anything.

Code Reviews and Testing

  • All pull requests will be reviewed by the project maintainers.
  • Ensure your code passes all tests before submitting a pull request.
  • Be responsive to feedback and make any necessary changes requested by the reviewers.

Thank you for contributing to the Dictionary API Client project!