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

Contribution Guidelines πŸ’» #52

Closed
danielcdz opened this issue Dec 6, 2024 · 0 comments
Closed

Contribution Guidelines πŸ’» #52

danielcdz opened this issue Dec 6, 2024 · 0 comments

Comments

@danielcdz
Copy link
Member

danielcdz commented Dec 6, 2024

βœ… Guidelines


Thank you for contributing to this project! πŸŽ‰ Together, we can build something amazing. Follow these steps to make your contributions seamless:


1. ⭐ Fork the Repository

  • Start by creating a fork of the main repository under your GitHub account.
  • Don’t forget to give the project a ⭐ star to show your support!

2. πŸ“₯ Clone Your Fork

  • Clone your forked repository to your local machine:
git clone https://github.com/YOUR_USERNAME/stark-cairo-nodes.git

3. πŸ”„ Add the Main Repository as Upstream

  • Optionally, add the main repository as an upstream remote to easily fetch updates and handle conflicts:
git remote add upstream https://github.com/KaizeNodeLabs/stark-cairo-nodes.git

4. 🌱 Create a New Branch

  • Work on a new branch to keep changes organized:
git checkout -b your-branch-name

5. ✍️ Make Atomic Commits

  • Each commit should focus on a single change to keep your history clean.
  • Use clear, descriptive messages for your commits:
git add .
git commit -m "Descriptive message for your changes"

6. πŸš€ Push Your Changes

  • Push your branch to your forked repository:
git push origin your-branch-name

7. πŸ“ Create a Pull Request (PR)

  • Open a PR to the main branch of the original repository.
  • Fill out the PR template carefully to ensure your contributions are reviewed promptly.
  • Note: PRs without a properly completed template will not be considered.

8. 🀝 Join the Contributors Telegram

  • Stay connected! Join our Contributors Telegram to collaborate, ask questions, and get updates. πŸ’¬

Let’s build together! πŸš€ If you have any questions, feel free to ask. Happy coding! πŸ’» ⚑

@danielcdz danielcdz pinned this issue Dec 6, 2024
@danielcdz danielcdz changed the title Contribution Guidelines βœ… Contribution Guidelines πŸ’» Dec 7, 2024
@danielcdz danielcdz changed the title βœ… Contribution Guidelines πŸ’» Contribution Guidelines πŸ’» Dec 7, 2024
@KaizeNodeLabs KaizeNodeLabs locked as resolved and limited conversation to collaborators Dec 7, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant