Skip to content

Commit fac3a51

Browse files
authored
Update README.md
1 parent 89e46cb commit fac3a51

File tree

1 file changed

+1
-27
lines changed

1 file changed

+1
-27
lines changed

README.md

Lines changed: 1 addition & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1777,33 +1777,7 @@ poetry run python -m pytest
17771777

17781778
## 8. Contributing
17791779

1780-
Contributions are appreciated, even if just reporting bugs, documenting stuff or answering questions. To contribute with a feature:
1781-
1782-
#### Setting Up for Contribution
1783-
1784-
1. **Fork the Repository**: Begin by forking the project repository. You can do this by visiting https://github.com/igormagalhaesr/FastAPI-boilerplate and clicking the "Fork" button.
1785-
1. **Create a Feature Branch**: Once you've forked the repo, create a branch for your feature by running `git checkout -b feature/fooBar`.
1786-
1. **Testing Changes**: Ensure that your changes do not break existing functionality by running tests. In the root folder, execute poetry run `python -m pytest` to run the tests.
1787-
1788-
#### Using pre-commit for Better Code Quality
1789-
1790-
It helps in identifying simple issues before submission to code review. By running automated checks, pre-commit can ensure code quality and consistency.
1791-
1792-
1. **Install Pre-commit**:
1793-
- **Installation**: Install pre-commit in your development environment. Use the command `pip install pre-commit`.
1794-
- **Setting Up Hooks**: After installing pre-commit, set up the hooks with `pre-commit install`. This command will install hooks into your .git/ directory which will automatically check your commits for issues.
1795-
1. **Committing Your Changes**:
1796-
After making your changes, use `git commit -am 'Add some fooBar'` to commit them. Pre-commit will run automatically on your files when you commit, ensuring that they meet the required standards.
1797-
Note: If pre-commit identifies issues, it may block your commit. Fix these issues and commit again. This ensures that all contributions are of high quality.
1798-
1. **Pushing Changes and Creating Pull Request**:
1799-
Push your changes to the branch using `git push origin feature/fooBar`.
1800-
Visit your fork on GitHub and create a new Pull Request to the main repository.
1801-
1802-
#### Additional Notes
1803-
1804-
**Stay Updated**: Keep your fork updated with the main repository to avoid merge conflicts. Regularly fetch and merge changes from the upstream repository.
1805-
**Adhere to Project Conventions**: Follow the coding style, conventions, and commit message guidelines of the project.
1806-
**Open Communication**: Feel free to ask questions or discuss your ideas by opening an issue or in discussions.
1780+
Read [contributing](CONTRIBUTING.md).
18071781

18081782
## 9. References
18091783

0 commit comments

Comments
 (0)