Skip to content

Latest commit

 

History

History
106 lines (62 loc) · 3.68 KB

CONTRIBUTING.md

File metadata and controls

106 lines (62 loc) · 3.68 KB
Raw

Contributing

⚠️ If you are just looking for help, see support

First off, thank you for taking the time to contribute! 👍

The following is a set of guidelines for contributing. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document.

Please note we have a code of conduct, please follow it in all your interactions with Copybara Action.

Developer documentation

Five other ways to contribute

⭐ Star this repo: it's quick and goes a long way! 🔝

🗣️ Spread the word

🐞 Report bugs

✅ Resolve issues

📝 Improve the documentation

Spread the Word

If you like Copybara Action, you can bring it up in a conversation at the coffee machine with your colleagues, on an internet forum, Hacker News, StackOverflow, Reddit, Quora, Linkedin, etc.

If you own a blog or are thinking of starting one, Copybara Action and how you use it might be a good subject for an article.

If you are using Copybara Action in one way or another, credits are always welcome.

Report Bugs

If you found a bug or want to propose a new feature, thank you for taking the time to report it 🙏 To do so, just open an issue and give as much information as you can about the bug you found and how to reproduce it.

⚠️ If you found a vulnerability, please see our security policy

Resolve Issues

If you are new to Copybara Action and are not sure where to start, we recommend that you look for issues labelled good first issue or easy

Before coding your pull request, please first discuss the change you wish to make by commenting on an existing issue or by opening an issue.

Pull Request Process

We follow the GitHub Flow.

GitHub Flow

Here is the process:

  1. Fork this repo

  2. Clone your fork on your development machine

  3. Create a branch named after the feature you're working on

    git checkout -b <branch_name>

  4. Write code and tests for your change then commit them to your branch and push them to your repo.

    git add .
git commit
git push origin <branch_name>

    How to write a descriptive commit message:

    • Describe what was done; not the result
    • Use the active voice
    • Use the present tense
    • Capitalize properly
    • Do not end in a period — this is a title/subject
    • Prefix the subject with its scope

  5. Open a pull request against Copybara Action

  6. Work with the project maintainer(s) to get your pull request reviewed

  7. Wait for your pull request to be merged and watch it to answer any questions or make any changes you're asked. You will make these modifications directly on your feature branch.

  8. Once it is merged, you can delete your feature branch

    git branch -d <branch_name>
git push origin --delete <branch_name>

Improve the Documentation

We also welcome improvements to the documentation of Copybara Action. If you want to fix a typo, add a sentence or two, an example, etc. we recommend that you open a pull request directly. For bigger changes to the documentation, we recommend to discuss it in an issue before spending any time making huge changes that could be rejected.

License

By contributing your code, you agree to license your contribution under the terms of our LICENSE

Code of Conduct

Read our Code of Conduct for Copybara Action.