Skip to content

Latest commit

 

History

History
92 lines (54 loc) · 3.79 KB

CONTRIBUTING.md

File metadata and controls

92 lines (54 loc) · 3.79 KB
Raw

Contribution guideline

Welcome! Thank you for contributing to the further development of Cyberon. We're always looking for new ways to improve our project and we appreciate any help you can give us 🤖.

What kinds of contributions are we looking for?

We value contributions, be it

  • bug fixes
  • feature enhancements
  • documentation or any ideas you want to put forward, We welcome it all.
Contributing

Please ensure all pull requests and contributions comply with the Developer Certificate of Origin.

Setting Up the Project

  • Fork the Repository

  • Clone Your Forked copy - git clone https://github.com/[YOUR-USERNAME]/Cyberon

  • OPTIONAL - to keep your fork up-to-date - use git remote add upstream https://github.com/[YOUR-USERNAME]/Cyberon

  • Navigate to the directory of project - cd Cyberon/

  • Create a new branch - git checkout -b [branch_name]

  • Install requirements - pip install -r requirements.txt

  • In the Cyberon directory, create a .env file add your tokens as BOT_TOKEN, DATABASE_CLIENT_URL and NASA_API_KEY respectively.

  • And a Cyberon now lives inside your pc

Test your local instance

  • There are a few steps you will need in order to set up a local instance of Cyberon. If you are not comfortable with doing this, you can join our server

  • You can use the Discord Developer portal to generate an invitation link, or you can use the Client ID from your Cyberon's application page to create a link yourself. If you wish to manually create the link, the format is:

https://discord.com/oauth2/authorize?client_id=<CLIENT_ID_HERE>&scope=bot

  • Visit the link and choose the server you would like to add the bot. All done!

Optional

Contributing

  • Take up an Issue or Raise one.

  • Discuss your proposed changes & Get assigned.

  • Get to work

  • If your changes are approved, do the changes in branch [branch_name].

  • Still in branch [branch_name].

  • Stage the changes git add .

  • Commit the changes with a header message explaining what you changed git commit -m "FIXED THE XXXX BUG"

  • After the changes in your branch are staged and commited, push the git push origin [branch_name] -u

image

  • You should see a quick option to do so appear at the top of your forked repository on GitHub under contribute dropdown. Click the "Open Pull Request" button to have GitHub automatically set up the pull request.

  • Congratulations! You've submitted your first pull request!

  • Once your PR is assessed and reviewed, It will get merged

  • That's it!

Tip: To keep your Fork Repo all branches updated with Upstream use this.

Claiming an Issue

All of our issues are open to contributors! If you see an open issue you would like to work on, please comment on the issue so we may assign it to you.

NOTE: Assigned issues that have not had any activity in a week will be unassigned.

If an issue is already assigned, please look for another issue to contribute to.We use labels to help categorise issues:

  • good first issue - These issues require minimal familiarity with our codebase. Please reserve these for first-time contributors.
  • help wanted - These issues are open to any contributors.
  • staff only - These issues are locked to project members/collaborators. Pull requests on these issues will not be accepted from outside contributors.