CONTRIBUTING.md

Contributing

Welcome to the Thunderbird Mobile Components project! We're excited to have you here and welcome your contributions.

Getting Started

Before you start contributing, please take a moment to familiarize yourself with the following:

• Mozilla Community Participation Guidelines: https://www.mozilla.org/en-US/about/governance/policies/participation/

Bug Reports and Feature Requests

If you encounter a bug or have a feature request, please follow these steps:

• Search the existing issues to see if your issue or feature has already been reported.
• If you can't find an existing issue, please open a new issue on GitHub.

Contributing Code

Important

The Thunderbird Mobile Components project is currently in the early stages of development. We welcome contributions, but please be aware that the codebase is subject to change and may not be fully stable yet.

Thank you for your willingness to contribute code! Here's how you can get started:

1. Find an issue:

• Check the issue tracker for open issues.
• Look for issues labeled good first issue for a good starting point.
• Propose a new feature by opening a new issue
• Avoid issues labeled unconfirmed or tb-team as they are not yet ready for contributions.

2. Discuss your plan:

• Leave a comment on the issue you want to work on, explaining what you plan to do. This helps avoid duplicate work and gets you feedback from the team.

3. Fork the repository:

• Create your own fork of the Thunderbird Mobile Components repository on GitHub.

4. Create a branch:

• Start a new branch from the main branch to keep your changes separate.
• Name your branch descriptively (e.g., fix-issue-123 or add-feature-xyz).

5. Make your changes:

• Write your code and commit it to your branch.

6. Test your changes:

• Run the project's tests to make sure everything works and that your changes don't introduce any regressions.
• If applicable, write new tests to cover your changes.

7. Push your changes:

• Upload your branch to your forked repository.

8. Open a pull request:

• Create a pull request to merge your changes into the main project.
• Provide a clear and concise description of your changes, including:
  • A reference to the issue you're addressing.
  • A summary of the changes you made.
  • Any relevant screenshots or testing results.