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

Update CONTRIBUTING.md #2661

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update CONTRIBUTING.md #2661

wants to merge 1 commit into from

Conversation

couci
Copy link

@couci couci commented Aug 22, 2024

adding tips of contributing

Before submitting your pull request

  • I agree to license my code under the MPL 2.0 license.
  • I rebased my work on top of the main branch.

Description

Please include a summary of the changes including relevant motivation and context.

Type of change

Added extra tips on contributing file

adding tips of contributing
##Tips for contributing:

* Choose an issue from https://github.com/mozilla/multi-account-containers/issues that you would like to work on.
* Fork the repository and follow the instructions for setting it up locally.
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

better add "instructions above" to make it clearer

Copy link
Contributor

@rafeerahman rafeerahman left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just some minor changes. Otherwise I think this is helpful.

We can continuously add to it, we talked about having "good first issues" instead of pointing them to all the issues but this can be done later.

@@ -36,3 +36,15 @@ You can then [open a pull request][pr] on [the l10n repository][l10n].
[l10n]: https://github.com/mozilla-l10n/multi-account-containers-l10n/
[pr]: https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests
[web-ext]: https://developer.mozilla.org/en-US/Add-ons/WebExtensions/Getting_started_with_web-ext

##Tips for contributing:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
##Tips for contributing:
## Tips for contributing:

* Run the add-on locally and try reproducing the issue.
* Debug add-ons by clicking the “Settings” icon in about:addons, and then clicking “Debug Add-ons”
* Click “Inspect” on the MAC add-on to open developer tools for the popup extension (see https://extensionworkshop.com/documentation/develop/debugging/ for more information)
* Once you have a fix ready, commit your changes with the following template
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* Once you have a fix ready, commit your changes with the following template
* Once you have a fix ready, commit your changes with the following commit message template

* Debug add-ons by clicking the “Settings” icon in about:addons, and then clicking “Debug Add-ons”
* Click “Inspect” on the MAC add-on to open developer tools for the popup extension (see https://extensionworkshop.com/documentation/develop/debugging/ for more information)
* Once you have a fix ready, commit your changes with the following template
* “Fix #<insert issue id #>: <description>”
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* “Fix #<insert issue id #>: <description>”
* “Fix #<insert issue id #>: <description>”

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants