-
Notifications
You must be signed in to change notification settings - Fork 2
Guide to Contribution
Welcome to Frolic! We are excited that you are interested in contributing to our open-source project. Your contributions will help make our APIs faster and more robust for the community.
- Introduction
- Getting Started
- Making Changes
- Testing
- Submitting Changes
- Code Review
- Documentation
- Issue Management
- Community Guidelines
- License
This is a project that aims to develop APIs quickly and efficiently using Rust. It prioritizes performance, security, and maintainability while providing a simple and easy-to-use API interface.
To contribute to the project, you will need to set up your local development environment and create a fork of the repository.
Fork the Frolic repository by clicking on the "Fork" button at the top right of the repository page. This will create a copy of the project under your GitHub account.
Clone the forked repository to your local machine using the following command:
git clone https://github.com/your-username/frolic.git
- Ensure you have Rust and Cargo installed on your system. Refer to the official Rust installation guide for instructions.
- Install additional project dependencies using Cargo:
cd your-rust-api-project
cargo build
Before starting to work on new features or bug fixes, it is essential to follow a proper branching strategy and code guidelines.
- Create a new branch for each feature or bug fix you are working on. Use descriptive names for your branches, such as
feature/add-user-authenticationorbugfix/fix-api-crash. - Keep your branches up to date with the
mainbranch to avoid conflicts when submitting a pull request.
- Follow the official Rust coding style and conventions to ensure consistency throughout the project.
- Write clear and concise code with meaningful comments where necessary.
- Make sure to test your changes thoroughly before submitting a pull request.
Testing is a crucial part of maintaining a robust project. All changes should be covered by appropriate tests.
Use the following command to run the tests:
cargo test
When adding new features or fixing bugs, include corresponding test cases to cover the changes you made.
Once you have made your changes and tested them, it's time to submit them for review.
Write descriptive commit messages that explain the purpose of the changes made in the commit. Follow the Conventional Commits format for your commit messages.
- Push your changes to your forked repository.
- Go to the original [Your Rust API Project Name] repository on GitHub.
- Click on the "New Pull Request" button.
- Select your fork and the branch containing your changes.
- Add a clear title and description for your pull request, detailing the changes you made.
- Submit the pull request for review.
Your pull request will be reviewed by project maintainers. Be open to feedback and make necessary changes if requested.
Contributions to the documentation are highly appreciated. If you add or modify functionality, make sure to update the relevant documentation accordingly.
If you encounter a bug or have an enhancement idea, feel free to open a new issue in the GitHub repository. Please provide a detailed description of the problem or feature request.
We follow a code of conduct to ensure an inclusive and respectful community. Be considerate and supportive of fellow contributors.
By contributing to Frolic, you agree that your contributions will be licensed under the project's chosen license. Make sure to read and understand the project's license before submitting any contributions.
Thank you for your interest in contributing to Frolic! We value and appreciate your efforts in making our project better for everyone. Happy coding!