Skip to content

Latest commit

 

History

History
94 lines (57 loc) · 5.33 KB

CONTRIBUTION.md

File metadata and controls

94 lines (57 loc) · 5.33 KB
Raw

Contributing Guidelines

Thank you for considering contributing to this project! We appreciate your interest and welcome contributions from the community. Whether you're reporting a bug, proposing a new feature, or improving our documentation, your input is valuable.

Here's how you can get involved and contribute to the project:

📖 Code of Conduct

Help team SpitFire be the best. Please read and follow our Code of Conduct

📥 Opening an Issue

Before creating issues, search through existing issues to see if your issue has previously been reported. If your issue exists, comment with any additional information you have. You may simply note "I have this problem too", which helps prioritize the most common problems and requests.

🐛 Bug Reports

A great way to contribute to the project is to send a detailed issue when you encounter a problem. We always appreciate a well-written, thorough bug report. ✌️

Since we are developers, we should write bug reports as a ticket that you would like to receive.

Fully complete the provided issue template. The bug report template requests all the information we need to quickly and efficiently address your issue. Be clear, concise, and descriptive. Provide as much information as you can, including steps to reproduce, stack traces, compiler errors, library versions, OS versions, and screenshots (if applicable).

⛲ Feature Requests

If you have an idea for a new feature or improvement that you'd like to see in this project, please let us know 🙌🏽.

Fully complete the provided issue template. The feature request template asks for all necessary information for us to begin a productive conversation. Be precise about the proposed outcome of the feature and how it relates to existing features. Include implementation details if possible.

📌 Pull Requests

We love pull requests! Before forking the repo and creating a pull request, it is usually best to first open an issue (if one doesn't exist) to discuss the changes, or discuss your intended approach for solving the problem in the comments for an existing issue.

Prioritize understanding over cleverness. Write code clearly and concisely. Remember that source code usually gets written once and read often. Ensure the code is clear to the reader. The purpose and logic should be obvious to a reasonably skilled developer, otherwise you should add a comment that explains it.

Follow existing coding style and conventions. Keep your code consistent with the Pep 8 style, formatting, and conventions in the rest of the code base. When possible, these will be enforced with a linter. Consistency makes it easier to review and modify in the future.

Include test coverage. Add tests when possible. Follow existing patterns for implementing tests.

Add documentation. Document your changes with code doc comments or in existing guides like README.md or DOCUMENTATION.md if affected.

Update the CHANGELOG for all enhancements and bug fixes. Include the corresponding issue number if one exists, and your GitHub username. (example: "- Fixed crash in profile view. #123 @jessesquires")

Resolve any merge conflicts that occur.

Promptly address any CI failures. If your pull request fails to build or pass tests, please push another commit to fix it.

When writing comments, use properly constructed sentences, including punctuation.

🧑🏽‍💻 Here is a workflow to contribute to projects.

  1. Fork the repository to your GitHub account.
  2. Clone your forked repository to your local machine.
git clone [url-to-your-fork]
  1. Change to the repository directory on your computer:
cd Spitfire-events-backend
  1. Create a branch using the git checkout command:
git checkout -B feature-name
  1. Make all necessary changes, following our coding style and guidelines. Always sync your branch with the original repo
  2. Commit your changes and push them to your forked repository:
    git add .
    git commit -m "Add feature-name"
    git push origin feature-name
  1. Create a Pull Request Go to the Pull Requests section of our repository. Click on the "New Pull Request" button. Select the branch containing your changes from your forked repository. Provide a clear and concise description of your changes in the PR description. Submit the pull request, and we'll review your changes as soon as possible.

🪪 License Information

Any contributions you make will be under the MIT Software License. In short, when you submit code changes, your submissions are understood to be under the same MIT License that covers the project.

🗨️ Feedback and Discussions

If you have general questions, suggestions, or want to discuss ideas with the community, you can also participate in discussions in the Discussions section.

Your contributions help make our project better, and we're grateful for your support! If you have any questions or need further assistance, feel free to reach out to us via the project's communication channels.