Skip to content

Latest commit

 

History

History
69 lines (48 loc) · 2.38 KB

CONTRIBUTING.md

File metadata and controls

69 lines (48 loc) · 2.38 KB

Contributing to SynonymSearch

Thank you for considering contributing to SynonymSearch! We welcome contributions from everyone. By participating in this project, you agree to abide by the following guidelines.

How to Contribute

Reporting Bugs

If you find a bug, please report it by opening an issue on the GitHub Issues page. Include as much detail as possible to help us understand and reproduce the issue.

Suggesting Enhancements

If you have an idea for an enhancement, please open an issue on the GitHub Issues page. Describe the enhancement you would like to see, why you think it would be useful, and how it should work.

Submitting Pull Requests

  1. Fork the repository: Click the "Fork" button at the top right of the repository page.
  2. Clone your fork: 
    git clone [email protected]:israelias/synonym-search.git
  3. Check Node.js version: Ensure you are using the correct Node.js version specified in .nvmrc: 
    nvm use
  4. Install dependencies using Yarn: 
    yarn install
  5. Create a branch: 
    git checkout -b feature/your-feature-name
  6. Make your changes: Implement your feature or fix the bug.
  7. Commit your changes: 
    git commit -m "Description of your changes"
  8. Push to your fork: 
    git push origin feature/your-feature-name
  9. Open a pull request: Go to the original repository and click the "New pull request" button. Select your branch from the "compare" dropdown.

Preferred Package Manager

Please use Yarn as the preferred package manager for this project.

Node.js Version

Ensure you are using the correct Node.js version specified in the .nvmrc file.

Code Style

Please follow the existing code style in the project. Ensure your code is clean and well-documented.

Commit Messages

Write clear and concise commit messages. Use the imperative mood in the subject line (e.g., "Fix bug" instead of "Fixed bug").

Code of Conduct

By participating in this project, you agree to abide by the Code of Conduct.

License

By contributing to SynonymSearch, you agree that your contributions will be licensed under the MIT License.

Thank you for your contributions!