👍 🎉 First off, thanks for taking the time to contribute! 🎉 👍
The following is a set of guidelines for contributing to Steemgigs Project which are hosted in the Steemgigs Organization account on GitHub and runs on Steemgigs.org. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request if feel anything is wrong with it. Both maintainers and owners of this project will review it.
I don't want to read this whole thing, I just have a question!!!
What should I know before I get started?
This project and everyone participating in it is governed by the Steemgigs Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to [email protected].
Note: Please don't file an issue to ask a question. Contact us via discord instead. You'll get faster answers that way.
We have an official discord server with a moderators in each category + a help center where the community chimes in with helpful advice if you have questions.
- Even though Discord is a chat service, sometimes it takes time for community members to respond — please be patient!
- Use the
#helpline-supportchannel for general questions or discussion about Steemgigs - Use other relevant channels that relate to what you want to do or ask
- There are many channels available, check the channel list
- Use the
Please see the ABOUT.md document to read about Steemgigs Project
We would appreciate if you can check through our Project board to understand our journey so far and what we need help with, what is pressing and features we would love to implement.
"Everyone has something to offer", Suggestion are welcome, so if you have one, you can create an issue, so that the owner and maintainers of this project can follow it up and review your suggestions.
This section should guide both developeer and non-developer on how they can contribute to this great project.
This section guides you through submitting a bug report for Steemgigs. Following these guidelines helps maintainers and the community understand your report 📝, reproduce the behavior 💻 💻, and find related reports 🔎.
Before creating bug reports, please check this list as you might find out that you don't need to create one. When you are creating a bug report, please include as many details as possible. Fill out the required template, the information it asks for helps us resolve issues faster.
Note: If you find a Closed issue that seems like it is the same thing that you're experiencing, open a new issue and include a link to the original issue in the body of your new one.
- You might be able to find the cause of the problem and fix things yourself. Most importantly, check if you can reproduce the problem, and if you can get the desired behavior by changing clearing browser cache.
- Check the FAQs for a list of common questions and problems.
- Chek our board and ensure it's not a feature we are currently working on or pinned on the project board.
- Perform a cursory search to see if the problem has already been reported. If it has and the issue is still open, add a comment to the existing issue instead of opening a new one.
Bugs are tracked as GitHub issues. After you've verified the bug and satudfy the above list, create an issue provide detail about the bug by filling in the template.
Explain the problem and include additional details to help maintainers reproduce the problem:
- Use a clear and descriptive title for the issue to identify the problem.
- Describe the exact steps which reproduce the problem in as many details as possible. For example, start by explaining what you wanted to do, e.g. what you did, step by step. When listing steps, don't just say what you did, but explain how you did it.
- Provide specific details about what you use. What kind of browser and operating system.
- Describe the behavior you observed after following the steps and point out what exactly is the problem with that behavior.
- Explain which behavior you expected to see instead and why.
- Include screenshots and animated GIFs which show you following the described steps and clearly demonstrate the problem. You can use this tool to record GIFs on macOS and Windows, and this tool or this tool on Linux.
- If you're reporting that Steemgigs crashed brings an unexpected error, Open your console, copy and paste the error in the console to assist us in fixing that error as swift as possible. Include the console message in the issue in a code block, a file attachment, or put it in a gist and provide link to that gist.
- If the problem wasn't triggered by a specific action, describe what you were doing before the problem happened and share more information using the guidelines below.
Provide more context by answering these questions:
-
Can you reproduce the problem?
-
Did the problem start happening recently (i.e. Have you performed that same action before without a glitch?
-
If the problem started happening recently, what was your previous experience when you do the same thing on Steemgigs?
-
Can you reliably reproduce the issue? If not, provide details about how often the problem happens and under which conditions it normally happens.
-
If the problem is related to working with some specific file or formats of content or image, does the problem happen for all similar cases and instances or only some?.
-
Include details about your which version of Steemgigs you're getting the error from => Live: Steemgigs.org Alpha or Steemgig Staging
-
What's the name and version of the OS you're using, which browser and device? the versions too could help as well.
-
Are you running Steemgigs behind a proxy or VPN? If so, give us helpful details that you care to share?
-
Are you using Steemgigs with multiple monitors? If so, can you reproduce the problem when you use a single monitor?
This section guides you through submitting an enhancement suggestion for Steemgigs, including completely new features and minor improvements to existing functionality. Following these guidelines helps maintainers and the community understand your suggestion 📝 and find related suggestions 🔎.
Before creating enhancement suggestions, please check this list as you might find out that you don't need to create one. When you are creating an enhancement suggestion, please include as many details as possible. Fill in the template, including the steps that you imagine you would take if the feature you're requesting existed.
Check the FAQs for a list of common questions and problems.
- Chek our board and ensure it's not a feature we are currently working on or pinned on the project board.
- Perform a cursory search to see if the feature suggestion or enhancement has already been suggested. If it has and the issue is still open, add a comment to the existing issue instead of opening a new one.
Enhancement suggestions are tracked as GitHub issues. After you've determined which repository your enhancement suggestion is related to, create an issue on that repository and provide the following information:
- Use a clear and descriptive title for the issue to identify the suggestion.
- Provide a step-by-step description of the suggested enhancement in as many details as possible.
- Provide specific examples to demonstrate the steps. You could sketch something to give us pictorial illustration (not compuslsory though).
- Describe the current behavior and explain which behavior you expected to see instead and why.
- Include screenshots and animated GIFs which help you demonstrate the steps or point out the part of Steemgigs which the suggestion is related to. You can use this tool to record GIFs on macOS and Windows, and this tool or this tool on Linux.
- Explain why this enhancement would be useful to most Steemgigs users and Steemgigs as a platform.
- Example of where such feature or enhancements have been implemented could also help.
- Specify which version of Steemgigs you're using. Live: Steemgigs.org Alpha or Steemgig Staging
- Specify the name and version of the OS you're using as well as the browser and browser version. (Not compulsory but will help us if provided)
Developers should please help fix bugs or implement features that are on the [Project board](We would appreciate if you can check through our Project board). If you have a suggestion instead, please don't hesitate to create an issue for it. We will address it.
See README.md on how to run the code.
To run the code locally,
- find this code in the head section of index.html:
<meta http-equiv="Content-Security-Policy" content="upgrade-insecure-requests">and comment it out temporarily - locate src/services/sc2.js and modify like so
import sc2 from 'sc2-sdk'
const sc = sc2.Initialize({
baseURL: 'https://v2.steemconnect.com',
// app: 'steemgigs.app',
app: 'steemgig.app',
// callbackURL: 'https://steemgigs.org/complete',
callbackURL: 'http://localhost:8080/complete',
scope: ['login', 'vote', 'comment', 'comment_delete', 'comment_options', 'custom_json', 'claim_reward_balance']
})
export default sc- Make your changes and commit, it is advisable to make a commit each time you implement a feature.
- before making pusing your commit and making a pull request, do the following
- test your code and be sure it works
- ensure your modification and addition does not disrupt an existing feature
- modify src/services/sc2.js like so
import sc2 from 'sc2-sdk'
const sc = sc2.Initialize({
baseURL: 'https://v2.steemconnect.com',
app: 'steemgigs.app',
// app: 'steemgig.app',
callbackURL: 'https://steemgigs.org/complete',
// callbackURL: 'http://localhost:8080/complete',
scope: ['login', 'vote', 'comment', 'comment_delete', 'comment_options', 'custom_json', 'claim_reward_balance']
})
export default sc- uncomment
- find this code in the head section of index.html:
<meta http-equiv="Content-Security-Policy" content="upgrade-insecure-requests">and be sure to uncomment it before you push
Note: Though, the code structure is straight forward and self explanatory but a quick walkthrough of this project's code will soon be added.
Right now we need to make the UI consitent accross the platform, we need experts in UI/UX (User experience and User Interface) to help us standardize our design by helping out with a style guide and consistent mockups that follow the style guide.
- Please take your time to read the ABOUT.md to undertand what this project is and its goals.
- Promotional materials such as banners are also welcome
- Feel free to contribute to any part of our website where its content need to be modified
- Check our board to see where we might really need content
- Please create an issue before going ahead to create contents. Wait for an approval by a maintainer, this implies that a maintainer will need to work with you as you create the content. With this, you will be sure of the approval of the content.
*See Bug report section
- If it fulfill our guidelines, you can go ahead and file it via utopian.io to get a great reward for fishing out that bug.
- You're not a programmers but have friends that are programmers, please dont hesitate to inform them that we need help
- You could help us promote Steemgigs by telling people about it via your posts, blogs, pages, social media platforms and telling your friends about it.
- If you've got other creative ways of assisting steemgigs project, let us know via discord, we will apppreciate it. You can also create an issue, if you consider it to be a tangible contribution.
Yeah, improvements are welcome, if you find this documentation buggy itself, you can create an issue for it so that we can look into it
Written and compiled by @jalasem. Thank you once again for your interest in contributing to this great project. With your effort, we can make it better and more useful to humanity.