Skip to content

Commit

Permalink
(#20857) Fix typo and grammar errors
Browse files Browse the repository at this point in the history
* Update README.md

* Update CONTRIBUTING.md

* Update consuming_recipes.md

* Update developing_recipes_locally.md
  • Loading branch information
VaibhavWakde52 committed Jun 20, 2024
1 parent 52419bd commit 1b24f7c
Show file tree
Hide file tree
Showing 4 changed files with 6 additions and 6 deletions.
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ To contribute follow the next steps:
got everything working or even if you need help. Add the text to the issue body (besides other comments): "fixes #IssueNumber"
in the body of the PR, referring to the issue of step 1.

The Conan Community works hard to review all the pull requests and provided assistance where need.
The Conan Community works hard to review all the pull requests and provide assistance where need.
The [Review Process](docs/review_process.md) is partially automated with the help of @conan-center-index-bot :rocket:

## Issues
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ You can open issues in the [issue tracker](https://github.com/conan-io/conan-cen
- Specify the name and version (`zlib/1.2.11`) and any relevant details about the fail configuration: Applied profile, building machine...

* :bulb: Request a **new library** to be added:
- Use the `[request]` label to search the library in the issue tracker in case the it was already requested.
- Use the `[request]` label to search the library in the issue tracker in case it was already requested.
- If not, use the same `[request]` tag in the title of the issue to help identifying them.
- Indicate the name and the version of the library you would like to have in the repository. Also links to the project's website,
source download/repository and in general any relevant information that helps creating a recipe for it.
Expand Down
2 changes: 1 addition & 1 deletion docs/consuming_recipes.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ Using your own ArtifactoryCE instance is easy. You can [deploy it on-premise](ht
[use only this remote](https://docs.conan.io/1/reference/commands/misc/remote.html?highlight=add%20new) and new recipe
revisions are only pushed to your Artifactory after they have been validated in your project.

The minimum solution, if still choosing to rely on ConanCenter directly, involves small changes to your client configuration by pinning the revision of every reference you consume in your project using using:
The minimum solution, if still choosing to rely on ConanCenter directly, involves small changes to your client configuration by pinning the revision of every reference you consume in your project using the following:

- [recipe revision (RREV)](https://docs.conan.io/1/versioning/revisions.html) can be added to each requirement.
Instead of `fmt/9.1.0` you can add a pound (or hashtag) to the end followed by the revision `fmt/9.1.0#c93359fba9fd21359d8db6f875d8a233`.
Expand Down
6 changes: 3 additions & 3 deletions docs/developing_recipes_locally.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,12 +76,12 @@ We recommend working from the `recipes/project` folder itself. You can learn abo

> **Note**: You can only change one recipe per pull request, and working from the [_recipe folder_](adding_packages/README.md#the-recipe-folder-conanfilepy) will help prevent making a few mistakes. The default for this folder is `all`, follow the link above to learn more.
The [entire workflow of a recipe](https://docs.conan.io/1/developing_packages/package_dev_flow.html) can be execute with the [`conan create`](https://docs.conan.io/1/reference/commands/creator/create.html). This should look like:
The [entire workflow of a recipe](https://docs.conan.io/1/developing_packages/package_dev_flow.html) can be executed with the [`conan create`](https://docs.conan.io/1/reference/commands/creator/create.html). This should look like:

* `conan create all/conanfile.py 0.0.0@ -pr:b=default -pr:h=default`

ConanCenter also has a few [support settings and options](supported_platforms_and_configurations.md) which highly recommend to test. For example
`conan create all/conanfile.py 0.0.0@ -o project:shared=True -s build_type=Debug` is a easy way to test more configurations ensuring the package is correct.
`conan create all/conanfile.py 0.0.0@ -o project:shared=True -s build_type=Debug` is an easy way to test more configurations ensuring the package is correct.

### Try it yourself

Expand Down Expand Up @@ -165,7 +165,7 @@ schema validation. There's are to encourage the best possible quality of recipes
### Yamlschema

* (Recommended) Use a dedicated Python virtualenv.
* Ensure you have required tools installed: `strictyaml` and `argparse` (better to uses fixed versions)
* Ensure you have required tools installed: `strictyaml` and `argparse` (better to use fixed versions)

```sh
pip install strictyaml==1.16 argparse==1.4
Expand Down

0 comments on commit 1b24f7c

Please sign in to comment.