Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Created CONTRIBUTING.md #607

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
63 changes: 63 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
# Contributing ✨

Contributions are always welcome and appreciated. Small contributions go a long way. You can contribute in many ways, such as:

## Types of Contributions

### Reporting Issues
- Report bugs at [GitHub Issues](https://github.com/wger-project/flutter/issues) or on our [Discord server](https://discord.gg/rPWFv6W). Come say Hi!👋
- When reporting a bug, please include:
- Your operating system name and version.
- Any details about your local setup that might be helpful in troubleshooting.
- Detailed steps to reproduce the bug.

### Fixing Bugs
- Look through the [GitHub issues](https://github.com/wger-project/flutter/issues) for bugs and ask to be assigned the issue.
- If you have a knack for finding bugs, you are welcome to fix those.

### Implementing Features
- Look through the [GitHub issues](https://github.com/wger-project/flutter/issues) for features or enhancements.
- Anything tagged with "help wanted" is open to whoever wants to implement it.

### Submitting Feedback
- The best way to send feedback is to file an issue at [GitHub Issues](https://github.com/wger-project/flutter/issues).
- If you are proposing a feature, explain your idea clearly, the use cases, and advantages in the [Discord server](https://discord.gg/rPWFv6W).

### Non-Code Contributions
- If you are new or not into development, you can start creating designs, animations, or translating the app on [Weblate](https://hosted.weblate.org/engage/wger/).

## Detailed Contribution Guidelines

### Reporting Issues
To report issues, please follow these guidelines:
- Check existing issues before creating a new one to avoid duplicates.
- Include a detailed description, steps to reproduce, expected behavior, and screenshots/logs.
- Use the provided template for consistency and clarity.

### Submitting Pull Requests
Follow these steps to submit a pull request:
1. Fork the repository.
2. Create a new branch (`git checkout -b feature-branch`).
3. Make your changes.
4. Commit your changes (`git commit -m 'Add feature'`).
5. Push to the branch (`git push origin feature-branch`).
6. Open a pull request on GitHub.

- Ensure your pull request adheres to the project's coding standards and includes necessary tests.
- Link to any related issues in your pull request description.

### Review Process
All pull requests will undergo a code review. Here's what to expect:
- Reviewers will check for code quality, functionality, and adherence to guidelines.
- You may receive feedback or requests for changes. Address these promptly and constructively.
- Once approved, your pull request will be merged.

### Discussion Participation
We encourage participation in discussions on issues, pull requests, and the [Discord server](https://discord.gg/rPWFv6W).
- Engage respectfully and constructively, providing clear and concise input.

## Resources
- [GitHub's Guide to Forking a Repository](https://docs.github.com/en/github/getting-started-with-github/fork-a-repo)
- [GitHub's Guide to Creating a Pull Request](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request)

Thank you for your contributions! Your support helps make our project better.