Skip to content

Latest commit

 

History

History
29 lines (19 loc) · 2.13 KB

CONTRIBUTING.md

File metadata and controls

29 lines (19 loc) · 2.13 KB
Raw

CONTRIBUTING GUIDELINES

Please take a moment to review this document in order to make the contribution process easy and effective for everyone involved.

Following these guidelines helps to communicate that you respect the time of the developers managing and developing this open source project. In return, they should reciprocate that respect in addressing your issue or assessing patches and features

Some contributing rules you should follow

  • Be critical: is the proposed library or paper or conference really awesome? If does, add it in the relevant section at the last position.Bear in mind, that in many cases one resource may fit multiple categories.Choose exactly one.

  • Make use of discussion properly (proper language)

  • Check if the resource you are adding already exists in the list

  • Check for broken or re-located links.

  • If this is your first contribution, You might also want to take up issues with the good first issue or the help wanted label.

  • Discuss the changes you wish to make by creating an issue or comment on an existing issue.

  • Description should start with a capital letter and be ended with proper punctuation.

  • Once you have been assigned the issue by the maintainer, you can go ahead to fork the repo, clone and make changes to fix the issue.

Making your Pull Request

  • Good pull requests - patches, improvements, new features - are a fantastic help. They should remain focused in scope and avoid containing unrelated commits.

  • you can create a pull request referencing the number of the issue you fixed.

  • Once, you have completed this, your pull request would be reviewed by a maintainer, if it satisfies the requirements of the corresponding issue to which it was made, it would be merged.

Kudos to you 🎈

Thank you for contributing to awesome-semantic-search.