openharmony/third_party_rust_lazycell
1
0
Fork 0
mirror of https://gitee.com/openharmony/third_party_rust_lazycell synced 2024-11-27 09:40:51 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
weekly_20240819
third_party_rust_lazycell/CONTRIBUTING.md
Nikita Pekin d88b2de8d3
chore: add copyright & contribution info 
Add information on updating copyright dates and the `CONTRIBUTORS.md` to the
`CONTRIBUTING.md`.

Closes #63.
2017-02-23 13:42:02 -05:00

2.3 KiB
Raw Permalink Blame History

How to Contribute

Contributions are always welcome! Please use the following guidelines when contributing to lazycell:

  1. Fork lazycell
  2. Clone your fork (git clone https://github.com/$YOUR_USERNAME/lazycell && cd lazycell)
  3. Create a new branch (git checkout -b new-branch)
  4. Make your changes
  5. Commit your changes (git commit -am "your message")
  • This project uses the conventional changelog format, so that we can easily update the CHANGELOG.md using clog.
  • In addition to the conventions defined above, we also use imp, wip, and examples.
  • Format your commit subject line using the following format: TYPE(COMPONENT): MESSAGE where TYPE is one of the following:
    • feat - A new feature
    • imp - An improvement to an existing feature
    • perf - A performance improvement
    • docs - Changes to documentation only
    • tests - Changes to the testing framework or tests only
    • fix - A bug fix
    • refactor - Code functionality doesn't change, but underlying structure may
    • style - Stylistic changes only, no functionality changes
    • wip - A work in progress commit (Should typically be git rebase'ed away)
    • chore - Catch all or things that have to do with the build system, etc.
    • examples - Changes to an existing example, or a new example
  • The COMPONENT is optional, and may be a single file, directory, or logical component. Can be omitted if commit applies globally
  1. Run the tests (cargo test)
  2. git rebase into concise commits and remove --fixups (git rebase -i HEAD~NUM where NUM is number of commits back)
  3. Push your changes back to your fork (git push origin $your-branch)
  4. Create a pull request! (You can also create the pull request first, and we'll merge when ready. This a good way to discuss proposed changes.)

Notes

  • Ensure that you update the copyright dates, if necessary (e.g. 2014, 2016 -> 2014, 2016-2017)
  • Make sure you add yourself to the CONTRIBUTORS.md!