snowykami/meilisearch
1
0
Fork 0
mirror of https://github.com/meilisearch/meilisearch.git synced 2025-11-04 09:56:28 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update CONTRIBUTING.md

Browse Source 
Change Git links to chris.beams post
This commit is contained in:
Erlend Sogge Heggen
2020-06-24 19:49:20 +02:00
committed by GitHub
parent 5f1ca15a7c
commit 4f2b68eef1
1 changed files with 8 additions and 25 deletions
Download Patch File Download Diff File Expand all files Collapse all files

33
CONTRIBUTING.md
View File

@@ -20,8 +20,7 @@ expanding into more specifics.
1. [Development](#development) 1. [Development](#development)
1. [Setup](#setup) 1. [Setup](#setup)
1. [Testing](#testing) 1. [Testing](#testing)
1. [Benchmarking](#benchmarking) 1. [Benchmarking](#benchmarking--profiling)
1. [Profiling](#profiling)
1. [Humans](#humans) 1. [Humans](#humans)
1. [Documentation](#documentation) 1. [Documentation](#documentation)
1. [Changelog](#changelog) 1. [Changelog](#changelog)
@@ -67,7 +66,7 @@ Please ensure your commits are small and focused; they should tell a story of
your change. This helps reviewers to follow your changes, especially for more your change. This helps reviewers to follow your changes, especially for more
complex changes. complex changes.
Familiarise yourself with the [Git Style Guide](https://github.com/agis/git-style-guide) and [Commit Message Guidelines](https://gist.github.com/robertpainsi/b632364184e70900af4ab688decf6f53). Familiarise yourself with [How to Write a Git Commit Message](https://chris.beams.io/posts/git-commit/).
### Github Pull Requests ### Github Pull Requests
@@ -76,7 +75,7 @@ Once your changes are ready you must submit your branch as a pull request.
#### Reviews & Approvals #### Reviews & Approvals
All pull requests must be reviewed and approved by at least one MeiliSearch team All pull requests must be reviewed and approved by at least one MeiliSearch team
member. The review process is outlined in the [Review guide](REVIEWING.md). member.
#### Merge Style #### Merge Style
@@ -88,42 +87,26 @@ solution and discuss if a change that large is even needed! This overall
will produce a quicker response to the change and likely produce code that will produce a quicker response to the change and likely produce code that
aligns better with our process. aligns better with our process.
### CI
Our current CI process is as follows:
WIP
## Development ## Development
### Setup ### Setup
See the [MeiliSearch Docs](https://docs.meilisearch.com/guides/advanced_guides/installation.html) for how to set up a development environment. See the [MeiliSearch Docs](https://docs.meilisearch.com/guides/advanced_guides/installation.html) for how to set up a development environment.
### Testing ### Benchmarking & Profiling
You can run MeiliSearch tests by... WIP We do not yet do any benchmarking, nor have we formalised our profiling. If you'd like to work on this please get in touch!
### Benchmarking
We do not yet do any benchmarking. If you'd like to make some, please get in touch!
### Profiling
We have not yet formalized our profiling methods.
## Humans ## Humans
After making your change, you'll want to prepare it for MeiliSearch users After making your change, you'll want to prepare it for MeiliSearch users (mostly humans). This usually entails updating documentation and announcing your feature.
(mostly humans). This usually entails updating documentation and announcing
your feature.
### Documentation ### Documentation
Documentation is very important to the Vector project. All contributions that Documentation is very important to MeiliSearch. All contributions that
alter user-facing behavior MUST include documentation changes. Please see alter user-facing behavior MUST include documentation changes. Please see
[GitHub.com/meilisearch/documentation](https://github.com/meilisearch/documentation) for more info. [GitHub.com/meilisearch/documentation](https://github.com/meilisearch/documentation) for more info.
### Changelog ### Changelog
Until we have guidelines in place, updating the [`Changelog`](/CHANGELOG.md) is solely the responsibility of MeiliSearch team members. Until we have guidelines in place, updating the [`Changelog`](/CHANGELOG.md) is solely the responsibility of MeiliSearch team members.