Update CONTRIBUTING.md changing Github to GitHub (#1217)

This commit is contained in:
Ikko Ashimine 2022-09-25 03:23:37 +09:00 committed by GitHub
parent 4db61d89a2
commit 2015227dc3
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -4,7 +4,7 @@ We would &nbsp;<img width="15" src="/img/love.svg">&nbsp; for you to contribute
## How to start ## How to start
If you are worried or dont know where to start, check out our next section explaining what kind of help we could use and where can you get involved. You can ask us a question on [Github discussions](https://github.com/surrealdb/surrealdb/discussions), or by tweeting [@tobiemh](https://twitter.com/tobiemh) or [@surrealdb](https://twitter.com/surrealdb) on Twitter. Alternatively chat with the [SurrealDB team on Discord](https://surrealdb.com/discord). If you are worried or dont know where to start, check out our next section explaining what kind of help we could use and where can you get involved. You can ask us a question on [GitHub discussions](https://github.com/surrealdb/surrealdb/discussions), or by tweeting [@tobiemh](https://twitter.com/tobiemh) or [@surrealdb](https://twitter.com/surrealdb) on Twitter. Alternatively chat with the [SurrealDB team on Discord](https://surrealdb.com/discord).
## Code of conduct ## Code of conduct
@ -90,7 +90,7 @@ Please avoid introducing new dependencies to SurrealDB without consulting the te
## Introducing new features ## Introducing new features
We would &nbsp;<img width="15" src="/img/love.svg">&nbsp; you to contribute to SurrealDB, but we would also like to make sure SurrealDB is as great as possible and loyal to its vision and mission statement. For us to find the right balance, please open a question on [Github discussions](https://github.com/surrealdb/surrealdb/discussions) with any ideas before introducing a new pull request. This will allow the SurrealDB community to have sufficient discussion about the new feature value and how it fits in the product roadmap and vision. We would &nbsp;<img width="15" src="/img/love.svg">&nbsp; you to contribute to SurrealDB, but we would also like to make sure SurrealDB is as great as possible and loyal to its vision and mission statement. For us to find the right balance, please open a question on [GitHub discussions](https://github.com/surrealdb/surrealdb/discussions) with any ideas before introducing a new pull request. This will allow the SurrealDB community to have sufficient discussion about the new feature value and how it fits in the product roadmap and vision.
This is also important for the SurrealDB lead developers to be able to give technical input and different emphasis regarding the feature design and architecture. Some bigger features might need to go through our [RFC process](https://github.com/surrealdb/rfc). This is also important for the SurrealDB lead developers to be able to give technical input and different emphasis regarding the feature design and architecture. Some bigger features might need to go through our [RFC process](https://github.com/surrealdb/rfc).
@ -146,7 +146,7 @@ git commit -m "[your commit message]"
git push origin "[the name of your branch]" git push origin "[the name of your branch]"
``` ```
6. Submit your changes for review, by going to your repository on Github and clicking the `Compare & pull request` button. 6. Submit your changes for review, by going to your repository on GitHub and clicking the `Compare & pull request` button.
7. Ensure that you have entered a commit message which details about the changes, and what the pull request is for. 7. Ensure that you have entered a commit message which details about the changes, and what the pull request is for.
@ -170,7 +170,7 @@ Presenting at meetups and conferences about your SurrealDB projects. Your unique
### Feedback, bugs, and ideas ### Feedback, bugs, and ideas
Sending feedback is a great way for us to understand your different use cases of SurrealDB better. If you want to share your experience with SurrealDB, or if you want to discuss any ideas, you can start a discussion on [Github discussions](https://github.com/surrealdb/surrealdb/discussions), chat with the [SurrealDB team on Discord](https://surrealdb.com/discord), or you can tweet [@tobiemh](https://twitter.com/tobiemh) or [@surrealdb](https://twitter.com/surrealdb) on Twitter. If you have any issues, or have found a bug, then feel free to create an issue on [Github issues](https://github.com/surrealdb/surrealdb/issues). Sending feedback is a great way for us to understand your different use cases of SurrealDB better. If you want to share your experience with SurrealDB, or if you want to discuss any ideas, you can start a discussion on [GitHub discussions](https://github.com/surrealdb/surrealdb/discussions), chat with the [SurrealDB team on Discord](https://surrealdb.com/discord), or you can tweet [@tobiemh](https://twitter.com/tobiemh) or [@surrealdb](https://twitter.com/surrealdb) on Twitter. If you have any issues, or have found a bug, then feel free to create an issue on [GitHub issues](https://github.com/surrealdb/surrealdb/issues).
### Documentation improvements ### Documentation improvements