Skip to content

Latest commit

 

History

History
56 lines (32 loc) · 3.7 KB

CONTRIBUTING.md

File metadata and controls

56 lines (32 loc) · 3.7 KB

Contributing

Thank you for considering adding to this project. What would we do without people like you?

Instructions for Contributing

Not sure where to start? That's okay, everyone has to start somewhere. If you have found a bug or want to suggest a feature, feel free to proceed to the issues page here, but first check out the creating an issue guide.

If you don't have a bug or feature request, please do not create an issue, the issue tracker is only for bugs and feature requests, instead please create a new Stack Overflow question. The community at Stack Overflow will help you with your problem, and if you ask a good question, other users will be able to use if as a valid resource for help.

Creating an Issue

Found a bug? Have a feature request? If so, I want to hear about it! However, please follow these guidelines when creating your issue. If you want your issue to be fixed or your feature to be added, you must properly format your issue.

First...

Before you create an issue, please check to see if there is a duplicate, if so, please do not create another issue.

Bug Reports

Found a bug? I want to do my best to try to fix it! Follow these guidelines to write a good bug report.

  • Version being used: If you are experiencing a bug, the version you are using is absolutely a valid factor to getting your bug fixed.
  • Your operating system: Sometimes, projects can work differently on different platforms. That being said, make sure you include your operating system.
  • Steps for reproduction: If you want to get a bug fixed, you must provide the steps for reproducing the bug, so it can be testing while solving your issue.
  • What you expected and what happened: What did you expect to happen? What really happened?
  • Description of what you saw or images: Remember, the person fixing your bug cannot see through your eyes, and needs to understand what happened. So, alway include a very detailed description or images of what happened.
  • What triggered the bug: Provide pieces of your code.

Some of these guidelines cannot apply to all bug reports. However, please do your best to provide all the necessary details to get the bug fixed.

Feature Requests

Want a new feature to be added to this project? No problem, as long as you write a good request. Here's what needs to be included.

  • The feature itself: What are your suggestions?
  • Description of the feature: Give a detailed description of your feature.
  • Why your feature should be considered: Why do you think your feature would be good to add to this project?

These are just the bare minimum of the details that need to be included. Your feature is even more likely to be implemented if you include more details.

Cloning This Repository

To clone this repository, use this hyperlink: https://github.com/BitPigeon/Divine.git.

If you have forked this repository, replace BitPigeon with your username.

Forking This Repository

If you see a bug and you know you can fix it, please fork this repository and create a branch with a descriptive name.

For example, a good branch name would be: 64-fix-binary-expression (64 is the number of the issue you're fixing).

Contributing Your Code

You are now ready to contribute your code to the main repository! If you are having trouble, ask for help! Remember, everyone has to start somewhere.