Skip to content

Latest commit

 

History

History
46 lines (34 loc) · 2.28 KB

CONTRIBUTING.md

File metadata and controls

46 lines (34 loc) · 2.28 KB
Raw

Contributing

Hi there! We're thrilled that you'd like to contribute to this project. Your help is essential for keeping it great.

Contributions to this project are released to the public under the project's open source license.

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

Start with an issue

  1. Open an issue to discuss the change you want to see. This helps us coordinate and reduce duplication.
  2. Once we've had some discussion, you're ready to code!

Submitting a pull request

  1. Fork and clone the repository
  2. Configure and install the dependencies: dotnet restore
  3. Make sure the tests pass on your machine: dotnet test
  4. Create a new branch: git switch -c my-branch-name
  5. Make your change, add tests, and make sure the tests still pass
  6. For UI updates, test your changes by executing a dotnet run in applicable UI-related project directories:
    • Atlassian.Bitbucket.UI.Avalonia
    • GitHub.UI.Avalonia
    • Atlassian.Bitbucket.UI.Windows
    • GitHub.UI.Windows
  7. Push to your fork and submit a pull request
  8. Pat your self on the back and wait for your pull request to be reviewed and merged.

Here are a few things you can do that will increase the likelihood of your pull request being accepted:

  • Match existing code style.
  • Write tests.
  • Keep your change as focused as possible. If there are multiple changes you would like to make that are not dependent upon each other, consider submitting them as separate pull requests.
  • Write a good commit message.

Resources