Skip to content

Commit

Permalink
feat: Added init CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Agrover112 committed Aug 17, 2021
1 parent 53764fc commit df646c3
Showing 1 changed file with 33 additions and 0 deletions.
33 changes: 33 additions & 0 deletions CONTRIBUTING.md
@@ -0,0 +1,33 @@
# 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

- Always use the English language.
- Make use of [discussion](https://github.com/Agrover112/final/discussions) properly (proper language)
- Check if the feature you are adding already exists.
- Contribution to new algorithms is always welcome.
- While adding algorithms test it properly and make sure all functionalities including single_run,multiple_run,benchmark are working properly.
- Contributing to docs or README is always welcome.
- Check for broken or re-located links.
- If this is your first contribution, You might also want to take up issues with the <b>good first</b> issue or the<b> help wanted </b>label.

- Discuss the changes you wish to make by creating an [issue](https://github.com/Agrover112/final/issues) or comment on an [existing issue]https://github.com/Agrover112/final/issues).
- 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.
- Please follow [**conventional commits**](https://www.conventionalcommits.org/en/v1.0.0-beta.2/)

## 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 :balloon:

---

Thank you for contributing to [awesome-semantic-search](https://github.com/Agrover112/awesome-semantic-search).

0 comments on commit df646c3

Please sign in to comment.