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.

Sign up for GitHub

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

Jump to bottom

docs: Write a contribution guide #3743

Closed
thomaseizinger opened this issue Apr 6, 2023 · 4 comments · Fixed by #4134
Closed

docs: Write a contribution guide #3743

thomaseizinger opened this issue Apr 6, 2023 · 4 comments · Fixed by #4134
Assignees
@p-shahi
Labels
difficulty:easy getting-started Issues that can be tackled if you don't know the internals of libp2p very well help wanted

Comments

@thomaseizinger
Copy link
Contributor

We have the most basic information written in the PR template but there are other questions that our contributors often run into:

  • We squash merge PRs, meaning we'd like to discourage force pushes the diff between pushes is easier to review this way for us.
  • Explain the use of mergify and the send-it label
  • Explain the use of convential commits for the PR title (which will become the commit after squashing)
  • Explain how to write changelog entries (see docs/release.md)
  • Explain how to bump versions (see docs/release.md)
  • Perhaps simplify the PR template by pointing to these new guidelines instead
@thomaseizinger thomaseizinger added help wanted getting-started Issues that can be tackled if you don't know the internals of libp2p very well difficulty:easy labels Apr 6, 2023
@thomaseizinger
Copy link
Contributor Author

There is some more information in: #2808

@thomaseizinger thomaseizinger mentioned this issue Apr 17, 2023
Closed
@p-shahi
Copy link
Member

p-shahi commented Apr 17, 2023

@thomaseizinger I can take this on if you don't mind

@thomaseizinger thomaseizinger mentioned this issue Apr 17, 2023
Closed
@thomaseizinger
Copy link
Contributor Author

@thomaseizinger I can take this on if you don't mind

That would be great!

@p-shahi p-shahi self-assigned this Apr 17, 2023
@tcoratger
Copy link
Contributor

@p-shahi If you need help here don't hesitate to tell me, I can have a look :)

@tcoratger tcoratger mentioned this issue Jun 29, 2023
Merged
4 tasks
@mergify mergify bot closed this as completed in #4134 Jun 30, 2023
mergify bot pushed a commit that referenced this issue Jun 30, 2023
@tcoratger
docs: add CONTRIBUTING.md
7eeb144 
Resolves #3743.

Pull-Request: #4134.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@p-shahi p-shahi

Labels
difficulty:easy getting-started Issues that can be tackled if you don't know the internals of libp2p very well help wanted
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

docs: add CONTRIBUTING.md tcoratger/rust-libp2p
3 participants
@thomaseizinger @p-shahi @tcoratger