Contributing

​

General rules

• Be Nice, Be Respectful (BNBR) - Treat everyone with kindness and professionalism
• Check existing issues - Before creating a new issue, make sure it doesn’t already exist
• Describe issues clearly - When creating an issue, provide detailed information about the problem
• Make proper commit messages - Write clear, descriptive commit messages and document your PR well
• Add comments and documentation - Always comment your code and add docstrings where possible
• Create PRs from branches - Never create a pull request from the main branch
• Follow code conventions - Write clean, readable code following the project’s style guidelines
• First come, first served - Issues are assigned on a “First Come, First Served” basis
• Tag the maintainer - Mention @ppmpreetham if your PR isn’t reviewed within a few days

​

How to contribute

​

Fork and clone the repository

1. Fork the project - Click the fork button on the FastrAPI repository
2. Clone your fork:
   git clone https://github.com/<YOUR_USER_NAME>/fastrapi.git
   
3. Navigate to the project directory:
   cd fastrapi
   
4. Add upstream remote:
   git remote add upstream https://github.com/sparckles/fastrapi.git
   
5. Verify remotes:
   git remote -v
   

​

Create a branch and make changes

6. Create a new branch:
   git checkout -b <YOUR_BRANCH_NAME>
   
7. Sync with upstream - Always pull from upstream to avoid merge conflicts:
   git pull upstream main
   
8. Make your changes - Implement your feature or bug fix
9. Stage and commit:
   git add .
   git commit -m "<YOUR_COMMIT_MESSAGE>"
   
10. Push to your fork:
    git push -u origin <YOUR_BRANCH_NAME>
    

​

Create a pull request

11. Open your forked repository on GitHub and click the “Compare & pull request” button
12. Fill in the PR template:
    • Give your PR a clear, descriptive title
    • Describe the changes you made in detail
    • Reference any related issues
13. Submit the PR by clicking “Create pull request”

​

Creating issues

1. Navigate to the FastrAPI repository
2. Click on the “Issues” tab
3. Click “New issue”
4. Select an appropriate issue template
5. Fill in the title and description with detailed information
6. Submit the issue

​

Resources

• Git & GitHub Tutorial
• Resolve merge conflicts
• CONTRIBUTING.md