Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Docs contributing conduct file #5

Merged

Conversation

NueloSE
Copy link
Contributor

@NueloSE NueloSE commented Nov 22, 2024

Create the Code of conduct template and Contributing files

📝 Summary

This documents provides a welcoming and inclusive environment to the new contributors and returning contributors, providing contributors with a comprehensive code of conduct and contribution file. These documents will ensure that contributors understand the expectations for participation and the processes for making contributions.

🪧 Related Issues

🛠️ Type of Change

Mark with an x all the checkboxes that apply (like [x]).

  • 📝 Documentation (updates to README, docs, or comments)
  • 🐛 Bug fix (non-breaking change which fixes an issue)
  • 👌 Enhancement (non-breaking change which adds functionality)
  • 💥 Breaking change (fix or feature that would cause existing functionality to change)

🔄 Changes Made

Created 2 files:

  • CODE_OF_CONDUCT.md: Community guidelines and expected behavior
  • CONTRIBUTION.md: Guide for new and returning contributors

🔧 Tests Results

No need to run test. The changes implemented was just documentation

📜 Checklist

Please check all the boxes that apply to this PR.

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream modules

@evgongora
Copy link
Collaborator

Hello! I think you mistaken both files.

@evgongora
Copy link
Collaborator

Also could you follow the PR template? We use it for a reason, thank you :)

@NueloSE
Copy link
Contributor Author

NueloSE commented Nov 25, 2024

@evgongora, thank you for your review. I am unclear about what you meant by "follow the PR template." I may have misunderstood the PR guide.

Here is my interpretation based on the contribution.md:

I created a branch named docs-contributing-conduct-file, following the contributor guide's example, For documentation: docs-meaningful-name.
Could you kindly guide me on how to improve this further? Thank you.

@NueloSE
Copy link
Contributor Author

NueloSE commented Nov 25, 2024

Hello! I think you mistaken both files.

i understand what am to do here

@evgongora
Copy link
Collaborator

@evgongora, thank you for your review. I am unclear about what you meant by "follow the PR template." I may have misunderstood the PR guide.

Here is my interpretation based on the contribution.md:

I created a branch named docs-contributing-conduct-file, following the contributor guide's example, For documentation: docs-meaningful-name. Could you kindly guide me on how to improve this further? Thank you.

Hey! @NueloSE I mean this PR template
https://github.com/ZencypherSolutions/semaphore-stellar-boilerplate/blob/main/.github/PR_TEMPLATE/PR_TEMPLATE.md

@evgongora
Copy link
Collaborator

Hello! I think you mistaken both files.

i understand what am to do here

You made a switch on both docs and placed the code of conduct in the contribution.md as well as the contribution in code of conduct

@NueloSE
Copy link
Contributor Author

NueloSE commented Nov 26, 2024

@evgongora thank you for your response. Implemented requested changes and ready for review

@evgongora
Copy link
Collaborator

@NueloSE Hey! Any updates on the review?

@NueloSE
Copy link
Contributor Author

NueloSE commented Nov 30, 2024

@evgongora requested changes have been implemented ready for review

@NueloSE
Copy link
Contributor Author

NueloSE commented Dec 1, 2024

@evgongora done

Copy link
Collaborator

@evgongora evgongora left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you!

@evgongora evgongora merged commit dcbc1ae into ZencypherSolutions:main Dec 1, 2024
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Semaphore Boilerplate] Issue 3: Create the Code of conduct template and Contributing files
2 participants