-
Notifications
You must be signed in to change notification settings - Fork 9
docs: add CONTRIBUTING.md to guide contributors #88
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,86 @@ | ||
Thank you for considering contributing to OpenFeature Rust SDK! We appreciate your help and look forward to collaborating with you. | ||
|
||
Here are the key steps for contributing to the OpenFeature Rust SDK: | ||
|
||
## How to Contribute | ||
|
||
1. **Fork the Repository**: Create a personal fork of the [repository](https://github.com/open-feature/rust-sdk.git) on GitHub. | ||
2. **Clone Your Fork**: | ||
```sh | ||
mkdir open-feature | ||
cd open-feature | ||
git clone https://github.com/open-feature/rust-sdk.git | ||
beeme1mr marked this conversation as resolved.
Show resolved
Hide resolved
|
||
cd rust-sdk | ||
``` | ||
3. **Create a Branch**: Create a new branch with a name that follows the recommended convention: | ||
```sh | ||
git checkout -b <prefix>/<gh-issue-number> | ||
``` | ||
- If there is a corresponding GitHub issue number, include it in the branch name. | ||
- Otherwise, name the branch meaningfully, using hyphens to replace spaces. | ||
- Use the following prefixes based on the type of change: | ||
- 🐛 Bug Fixes: `fix/<description>` or `fix/<issue-number>` | ||
- ✨ New Features: `feat/<description>` or `feat/<issue-number>` | ||
- 🧹 Chore: `chore/<description>` or `chore/<issue-number>` | ||
- 📚 Documentation: `docs/<description>` or `docs/<issue-number>` | ||
- 🚀 Performance: `perf/<description>` or `perf/<issue-number>` | ||
- 🛠️ Build: `build/<description>` or `build/<issue-number>` | ||
- 📦 Dependencies: `deps/<description>` or `deps/<issue-number>` | ||
- 🚦 CI: `ci/<description>` or `ci/<issue-number>` | ||
- 🔄 Refactoring: `refactor/<description>` or `refactor/<issue-number>` | ||
- 🔙 Reverts: `revert/<description>` or `revert/<issue-number>` | ||
- 🎨 Styling: `style/<description>` or `style/<issue-number>` | ||
- 🧪 Tests: `test/<description>` or `test/<issue-number>` | ||
|
||
4. **Make Changes**: Implement your changes or additions to the codebase. | ||
5. **Commit Changes**: Stage your changes and commit them with a descriptive message. | ||
6. **Push to Your Fork**: Push your branch to your forked repository. | ||
7. **Create a Pull Request**: Open a pull request from your forked repository to the main OpenFeature Rust SDK repository. | ||
8. **Address Feedback**: If there are any comments or requested changes, address them in your branch and push the updates. | ||
9. **Merge**: Once your pull request is approved, it will be merged into the main repository. | ||
|
||
## Development Setup | ||
|
||
To set up your development environment, ensure you have the following installed: | ||
|
||
- [Rust & Cargo](https://www.rust-lang.org/tools/install) | ||
- [VS Code](https://code.visualstudio.com) | ||
- [Rust Analyzer VS Code Extension](https://marketplace.visualstudio.com/items?itemName=rust-lang.rust-analyzer) | ||
|
||
After installing Rust, you can verify your installation with following command: | ||
|
||
```sh | ||
rustc --version | ||
``` | ||
|
||
After installing Cargo, you can verify your installation with following command: | ||
|
||
```sh | ||
cargo --version | ||
``` | ||
|
||
## Build, Test, Document and Run the Project | ||
|
||
To build the project, execute the following command: | ||
```sh | ||
cargo build | ||
``` | ||
|
||
To test the project, execute the following command: | ||
```sh | ||
cargo test | ||
``` | ||
|
||
To build documentation for the project, execute the following command: | ||
```text | ||
cargo doc | ||
``` | ||
|
||
To run the project, execute the following command: | ||
```sh | ||
cargo run | ||
``` | ||
|
||
## Closing Note | ||
|
||
Thank you 🙏 for your interest and support! Your contributions help us improve and grow 🌱 the OpenFeature Rust SDK. We truly appreciate your time and effort in making our project better. If you have any questions or need assistance, please don’t hesitate to reach out on Slack in the [#openfeature-rust](https://cloud-native.slack.com/archives/C05RG7F93NV) channel! | ||
beeme1mr marked this conversation as resolved.
Show resolved
Hide resolved
|
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.