Skip to content

Latest commit

 

History

History
37 lines (27 loc) · 3.29 KB

CONTRIBUTING.md

File metadata and controls

37 lines (27 loc) · 3.29 KB
Raw

Contributing

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.

Please note we have a code of conduct, please follow it in all your interactions with the project.

Code of Conduct

The code of conduct is described in CODE_OF_CONDUCT.md

What do I need to know to help?

If you are looking to help to with a code contribution our project uses Vue3, HTML/CSS, Javascript and java for the back. If you don't feel ready to make a code contribution yet, no problem! You can also check out the documentation issues or the design issues that we have here.

How do I make a contribution?

Never made an open source contribution before? Wondering how contributions work in the in our project? Here's a quick rundown!

  1. Find an issue that you are interested in addressing or a feature that you would like to add.
  2. Fork the repository associated with the issue to your local GitHub organization or repository. This means that you will have a copy of the repository under your-GitHub-username/screel.
  3. Clone the repository to your local machine using git clone https://github.com/github-username/screel.git.
  4. Create a new branch for your fix using git checkout -b branch-name-here.
  5. Make the appropriate changes for the issue you are trying to address or the feature that you want to add.
  6. Use git add insert-paths-of-changed-files-here to add the file contents of the changed files to the "snapshot" git uses to manage the state of the project, also known as the index.
  7. Use git commit -m "Insert a short message of the changes made here" to store the contents of the index with a descriptive message.
  8. Push the changes to the remote repository using git push origin branch-name-here.
  9. Submit a pull request to the upstream repository.
  10. Title the pull request with a short description of the changes made and the issue or bug number associated with your change. For example, you can title an issue like so "Added more log outputting to resolve #4352".
  11. In the description of the pull request, explain the changes that you made, any issues you think exist with the pull request you made, and any questions you have for the maintainers. It's OK if your pull request is not perfect (no pull request is), the reviewers will be able to help you fix any problems and improve it!
  12. Wait for the pull request to be reviewed by a maintainers.
  13. Make changes to the pull request if the reviewing maintainer recommends them.
  14. Celebrate your success after your pull request is merged! you are part of the community now.

Where can I go for help?

If you need help, you can ask questions on our mailing list, IRC chat, or simply email us at [email protected].

What does the Code of Conduct mean for me?

Our Code of Conduct means that you are responsible for treating everyone on the project with respect and courtesy regardless of their identity. If you are the victim of any inappropriate behavior or comments as described in our Code of Conduct, we are here for you and will do the best to ensure that the abuser is reprimanded appropriately, per our code.