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

Feature Add and Update #26

Merged
merged 8 commits into from
Jul 3, 2021
Merged

Conversation

ghost
Copy link

@ghost ghost commented May 14, 2021

Changed some line of script and Updated more in it like Contribution Header. Defined requirements paragraph. It will help more to engage with contributors and developers to contribute.

I tried to summarize the documentation to more better in this Python project.

Changed some line of script and Updated more in it like Contribution Header. Defined Requirments paragraph. It will help more to engage with contributors and developers to contribute.
@ghost
Copy link
Author

ghost commented Jun 11, 2021

this PR related to issue #28

@Cyb3rWard0g
Copy link
Collaborator

Thank you very much @thegautamkumarjaiswal ! I believe the contribution section needs some updates from a grammar perspective. I will read it again tomorrow.

@ghost
Copy link
Author

ghost commented Jun 11, 2021

And I am thinking, create seperate CONTRIBUTING.md file for contrubtion related guildelines.

Copy link

@osV22 osV22 left a comment

Choose a reason for hiding this comment

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

A few suggestions for the Contribution section, I noted some things that perhaps can be of help.

Contributions

Contributions are appreciated given the number of projects @Cyb3rWard0g is often working on.

There is no strict guideline, but please be mindful of the following:

  • One pull request per issue
  • Select one or more label when you submit an issue
  • Make sure you are in the correct branch [Master]
  • Try to avoid sizeable changes unless warranted
  • Be patient and polite as the project is still relatively small; which is why we would appreciate your help where possible

Gautam kumar jaiswal and others added 4 commits June 12, 2021 21:40
@ghost
Copy link
Author

ghost commented Jun 12, 2021

@Cyb3rWard0g @osV22 Please review the PR and suggest if needed or merge the PR.

@ghost ghost changed the title Updated README.md file Feature Add and Update Jun 12, 2021
CONTRIBUTING.md Outdated
* [Pull Request](#step-6--pull-request)

## Code of Conduct
This project and everyone participating in it is governed by the Contributor Covenant. Make sure to read it here: [CODE_OF_CONDUCT.md](https://github.com/thegautamkumarjaiswal/ATTACK-Python-Client/blob/master/CODE_OF_CONDUCT.md)
Copy link
Collaborator

Choose a reason for hiding this comment

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

Can we change the URL to point to the official repo? Please and thank you!

README.md Outdated
@@ -52,6 +55,14 @@ cd ATTACK-Python-Client
pip install .
```

## Contribution

* Now the Project under production, It will great if you will contribute to the project. Feel free to show your interest in to add more features and testing. Also let us know to add more in this project.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Can we change it to:

Now that the project is more stable, it would be great to get your feedback and hopefully get more contributions to the project. Let us know if you have any features in mind. We would love to collaborate to make them happen in the project.

README.md Outdated
## Contribution

* Now the Project under production, It will great if you will contribute to the project. Feel free to show your interest in to add more features and testing. Also let us know to add more in this project.
* There are some basic guidlines to contribute is first connect with to know what we are doing and expanding.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Check our basic contribution guidelines and submit an issue with your ideas.

README.md Outdated

* Now the Project under production, It will great if you will contribute to the project. Feel free to show your interest in to add more features and testing. Also let us know to add more in this project.
* There are some basic guidlines to contribute is first connect with to know what we are doing and expanding.
* Start with basic and in little bit part, One small Pr at a time.
Copy link
Collaborator

Choose a reason for hiding this comment

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

we can remove this one

README.md Outdated
* Now the Project under production, It will great if you will contribute to the project. Feel free to show your interest in to add more features and testing. Also let us know to add more in this project.
* There are some basic guidlines to contribute is first connect with to know what we are doing and expanding.
* Start with basic and in little bit part, One small Pr at a time.
* Good Title and Description about what you are adding or updating.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Be concise but clear when adding a title and description to your feature proposal.

@Cyb3rWard0g
Copy link
Collaborator

Thank you very much @thegautamkumarjaiswal and @osV22 ! I added some comments. I believe the last bullet points of the contributing section in the main read me still need the bullet points provided by @osV22 :

#26 (review)

Once again, thank you so much for taking the time to contribute to this project! 👍🏾

@ghost
Copy link
Author

ghost commented Jul 3, 2021

@Cyb3rWard0g and @osV22 Please review. I have updated.

README.md Outdated
* Check our basic contribution guidelines and submit an issue with your ideas.
* Be concise but clear when adding a title and description to your feature proposal.
* One pull request per issue.
* Select one or more label when you submit an issue.
Copy link
Collaborator

Choose a reason for hiding this comment

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

labels

README.md Outdated
* Select one or more label when you submit an issue.
* Make sure you are in the correct branch [Master].
* Try to avoid sizeable changes unless warranted.
* Be patient and polite as the project is still relatively small, which is why we would appreciate your help where possible and We will definetly reach to you, to see you awsome work.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Be patient and polite as the project is still relatively small, which is why we would appreciate your help where possible.

@@ -0,0 +1,87 @@
# Contributing Guidelines

When contributing to this repository, Please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.
Copy link
Collaborator

Choose a reason for hiding this comment

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

When contributing to this repository, please share your proposal via a GitHub issue and our discord server.

Copy link
Author

Choose a reason for hiding this comment

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

Wow! Its great if we have discord . Thanks to share I will add this.

Copy link
Collaborator

Choose a reason for hiding this comment

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

Yes! We have a discord for the OTR community 👍🏾 feel free to join. the link is the automatic invitatio

README.md Outdated
Comment on lines 39 to 40
taxii2-client >= 2.2.2
six >= 1.15.0
Copy link
Collaborator

Choose a reason for hiding this comment

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

taxii2-client >= 2.3.0
six >= 1.16.0

Copy link
Author

Choose a reason for hiding this comment

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

@Cyb3rWard0g anything else you would like to add and change in these files ?

Copy link
Collaborator

Choose a reason for hiding this comment

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

I believe other than that, it looks good! Thank you again for contributing to the project :)

@Cyb3rWard0g
Copy link
Collaborator

Thank you @thegautamkumarjaiswal ! It all looks good. Merging now.

@Cyb3rWard0g Cyb3rWard0g merged commit 8607746 into OTRF:master Jul 3, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants