euzuandGitHub
38813bb672
- Add Makefile to simplify installing required tools - Add CONTRIBUTING.md welcome new contributors - Add fmt, lint, test tasks to makefile and update CONTRIBUTING.md - Add CI workflow - Log with local date
1.7 KiB
Contributing
Thank you for your interest in contributing to Tuliprox! We welcome contributions of all kinds, including bug fixes, new features, documentation improvements, and more. To ensure a smooth contribution process, please follow the guidelines outlined below.
How to Contribute
Prerequisites
To contribute you will need Rust, cargo, cross, trunk, wasm-bindgen, and cargo-set-version installed. You can install them using the following command:
make install-tools
Steps to Contribute
-
Fork the Repository: Start by forking the Tuliprox repository to your GitHub account.
-
Clone Your Fork: Clone the forked repository to your local machine.
git clone git@github.com:your-username/tuliprox.git cd tuliprox -
Create a Branch: Create a new branch for your contribution.
git checkout -b feature/your-feature-name -
Make Your Changes: Implement your changes in the codebase. Please ensure that your code follows the existing style and conventions.
-
Test Your Changes: Format, lint, and run tests to ensure that your changes are clean and tidy and do not break existing functionality.
make fmt lint test -
Commit Your Changes: Commit your changes with a descriptive message.
git add . git commit -m "Add your descriptive message here" -
Push Your Changes: Push your changes to your forked repository.
git push origin feature/your-feature-name -
Create a Pull Request: Open a pull request on the original Tuliprox repository, describing your changes and their purpose.
-
Address Feedback: Be responsive to any feedback or requests for changes from the maintainers.