Skip to content
Permalink
Branch: master
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
199 lines (131 sloc) 11 KB

Contributing to scona project

Welcome to the scona GitHub repository, and thank you for thinking about contributing! 😃❤️😃

The point of this file is to make it suuuuuper easy for you to get involved. So if you have any questions that aren't covered here please let us know! Check out the Share your thoughts section below for more details.

Before you start you'll need to set up a free GitHub account and sign in. Here are some instructions.

Scroll down or jump to one of the following sections:

Our detailed development guide can be found at DEVELOPMENT_GUIDE.md. Once you've read the contributing guidelines below, and if you think you need the additional information, check out those instructions too.

Share your thoughts

Although GitHub calls them issues, we'd like you to think of them as conversation starters. They're our way of communicating across all the members of the team.

(If you're here you already are a member of the scona team.)

Your thoughts can be questions, bugs, requests, or a myriad of other suggestions. In the next section we'll talk through some of the labels on each issue to help you select the ones you'd most like to help with.

GitHub has a nice set of help pages if you're looking for more information about discussing projects in issues.

Labels

You can find all currently open conversations under the issues tab.

The current list of labels are here and include:

  • question These issues are questions and represent a great place to start. Whomever has opened the issue wants to hear from you!

    To reply, read the question and then respond in a variety of different ways:

    • If you want to just agree with everything you can react to the post with one of 👍 😄 ❤️ 🎉 🚀
    • Alternatively you could write a comment to:
      • express your emotions more dramatically (check out this cheat sheet for emojis you might need)
      • provide a more nuanced description of your answer (using your words)
      • ask for a clarification
      • ask a follow up question

  • no-code These issues don't require any coding knowledge.

    If you're looking to contribute but aren't very confident in your coding skills these issues are a great place to start.

    All issues with the no code label are suggesting documentation tasks, or asking for feedback or suggestions.


  • good-first-bug These issues contain a task that anyone with any level of experience can help with.

    A major goal of the project is to have as many people as possible complete their very first pull request on one of these issues. They will always have explicit information on who to contact to help you through the process.

    Remember: There are no stupid questions!

    We can not encourage you enough to submit even the tiniest change to the project repository. Let's go from 😕 & 😧 to 😃 & 🎉 together!


  • help-wanted These issues contain a task that a member of the team has determined we need additional help with.

    If you have particular skills then consider reading through these issues as they are a great place to offer your expertise.

    If you aren't sure what to offer, you could also recommend issues to your friends/colleagues who may be able to help.


  • bug These issues point to problems in the project.

    If you find a bug, please give as much detail as possible in your issue.

    If you experience the same bug as one already listed, please add any additional information that you have as a comment.


  • request These issues are asking for features (or anything else) to be added to the project.

    If you have a good idea and would like to see it implemented in the scona project please open a new issue and add in as much detail as possible.

    Please try to make sure that your feature is distinct from any others that have already been requested or implemented. If you find one that's similar but there are subtle differences please reference the other request in your issue.

Make a change

Once you've identified one of the issues above that you feel you can contribute to, you're ready to make a change to the project repository! 🎉😃

  1. First, describe what you're planning to do as a comment to the issue, (and this might mean making a new issue).

    Check in with one of the scona development team to ensure you aren't overlapping with work that's currently underway and that everyone is on the same page with the goal of the work you're going to carry out.

    This blog is a nice explanation of why putting this work in up front is so useful to everyone involved.

  2. Fork the scona to your profile.

    You can now do whatever you want with this copy of the project. You won't mess up anyone else's work so you're super safe.

    Make sure to keep your fork up to date with the master repository.

  3. Make the changes you've discussed.

    Try to keep the changes focused rather than changing lots of things at once. If you feel tempted to branch out then please literally branch out: create separate branches for different updates to make the next step much easier!

    We have a development guide that covers:

    It's in a separate file (called DEVELOPMENT_GUIDE.md) because we don't want you to feel overwhelmed when you contribute for the first time to scona. Everyone has different comfort levels with things like linting, testing and writing documentation. All are really important, but we don't need you to submit a perfect pull request! Pick the parts that are useful from that guide, or just do your best and we'll help out once you've shared your changes.

  4. Submit a pull request.

    A member of the executive team will review your changes, have a bit of discussion and hopefully merge them in! N.B. you don't have to be ready to merge to make a pull request! We encourage you to submit a pull request as early as you want to. They help us to keep track of progress and help you to get earlier feedback.

Success!! 🎈🎈🎈 Well done! And thank you 😃🎉

Recognising contributions

If you're logged into GitHub you can see everyone who has contributed to the repository via our live contributors page. (You might have to add WhitakerLab/scona as the repository name before you click to sign in via GitHub.)

These pages are powered by the Let's all build a hat rack project, and we love them.

Quoting from their website:

Open Source project contribution focuses a lot on the code committed to projects, but there is so much more that goes on behind the scenes that is just as valuable to FOSS than the code itself.

LABHR seeks to find those that provide these non-code contributions, and thank them.

LABHR started as an idea by Leslie Hawthorn. She advocates openly thanking people on social media, and writing recommendations.

This idea was extended by Katie McLaughlin with her work on automating this process on GitHub.

How to get in touch

If you have a question or a comment we'd love for you to open an issue because that will be our fastest way of communicating, getting the answers to you and (if necessary) making a change.

If you'd prefer email, you can contact Isla at islastaden@gmail.com. If she doesn't reply to your email after a couple of days please feel free to ping her again.

Thank you!

You are awesome. 😍☀️

And if you've found typos in this (or any other) page, you could consider submitting your very first pull request to fix them via the typos and broken links issue!

You can’t perform that action at this time.