-
Notifications
You must be signed in to change notification settings - Fork 0
Contributing Guide
Illia Kotvitskyi edited this page Sep 8, 2024
·
2 revisions
We welcome contributions to Trendlink! Please follow the guidelines below to help us maintain a smooth process.
- Fork the repository: Create your own copy by forking Trendlink.
-
Create a feature branch:
git checkout -b feature/your-feature-name
-
Commit your changes: Write clear, descriptive commit messages.
git commit -m 'Add: Description of the feature'
-
Push to your branch:
git push origin feature/your-feature-name
- Open a Pull Request (PR): Submit your PR with a clear description of the changes made and link to relevant issues.
- Follow coding standards: Adhere to project coding conventions.
- Write tests: Ensure new features and bug fixes are covered with unit/integration tests.
- Document your changes: Update relevant documentation (e.g., README, Wiki) if necessary.
-
Stay up-to-date: Sync with the latest main branch before submitting your PR.
git pull origin main
- Ensure all existing and new tests pass.
- Provide detailed descriptions of the changes in the PR.
- Be ready for feedback: Address any comments or requested changes by reviewers.
- Please check the issue tracker before submitting new issues to avoid duplicates.
- Include as much detail as possible, such as platform, browser, and steps to reproduce the issue.