Skip to content

Latest commit

 

History

History
83 lines (58 loc) · 5.44 KB

CONTRIBUTING.md

File metadata and controls

83 lines (58 loc) · 5.44 KB

Contributing

Hey there! We love getting contributions from the community, so if you're interested in helping out with Team Production System, we'd be thrilled to have you on board. Here's what you need to do:

  1. First off, fork the repository so you can make changes to your own copy of the code. Fork the Team Production System repository on GitHub by clicking the "Fork" button at the top right of the repository page. This will create a copy of the repository in your own GitHub account.

  2. Create a new branch for your changes - Once you've forked the repository, create a new branch for your changes. We recommend naming the branch something descriptive, like "my-new-feature", so it's clear what you're working on. After this operation the URL of the project will change to:

https://github.com/<YourUserName>/projectname

  1. Clone the project into your local machine - In order for you to perform this step, you must have Git installed locally in your machine. If you don’t, refer to the official Git docs on how to get started.

  2. Copy the forked project URL, and proceed to your local machine where you will open the terminal, and proceed with the command below:

git clone https://github.com/<YourUserName>/<projectname>

This will create a copy of the project on your local machine. Now that you have cloned the repo change the path to point to your repository directory. To do that use this command:

cd project folder name

To create a new branch using Git, run the following command:

git checkout -b my-new-feature

Replace "my-new-feature" with your chosen branch name.

  1. Now it's time to make your changes! This is the fun part, where you get to add your own personal touch to the code. When you're done, commit your changes with a message that describes what you did, like "Add awesome new feature".
git commit -m "Add awesome new feature"

Replace "Add awesome new feature" with a short, descriptive message that summarizes the changes you've made.

  1. After you've committed your changes, push them to your fork of the repository. This will make your changes visible to others, and allow you to submit a pull request. Push your changes to your forked repository on GitHub using the following command:
git push origin my-new-feature

Replace "my-new-feature" with the name of the branch you created in step 2.

  1. Finally, submit a pull request to the main repository. This lets us know that you've made some changes that you'd like us to review and potentially incorporate into the main codebase. We'll take a look as soon as we can, and get back to you with any feedback or questions we have. Visit the Team Production System repository on GitHub and click the "New pull request" button. Select your forked repository and the branch you created in step 2, and then click "Create pull request". This will open a new pull request in the main repository.

One last thing - we want to make sure that everyone who contributes to Team Production System feels welcome and respected. So please make sure to follow our code of conduct, which you can find here 👉 code of conduct. Thanks, and happy coding!

Submitting Bug Issues

We strive to make Team Production System as bug-free as possible, but sometimes bugs slip through the cracks. If you come across a bug, we encourage you to submit an issue on our GitHub repository. Here's how to do it:

  1. Check if the issue has already been reported by searching the existing issues on GitHub. If the issue has already been reported, you can add additional information or give it a thumbs up reaction to let us know it's affecting multiple people.
  2. If the issue has not been reported, click the "New issue" button in the "Issues" tab on GitHub.
  3. Choose the "Bug report" issue template and fill out as much information as possible, including steps to reproduce the issue and any error messages you received. The more information you can provide, the easier it will be for us to reproduce and fix the bug.
  4. Click "Submit new issue" to create the issue.

We will review the issue and try to reproduce the bug. Once we've identified the problem, we will work on a fix and provide updates on the progress. Thank you for helping us make Team Production System better by reporting bugs!

Requesting Features

Do you have a great idea for a new feature or improvement to the Team Production System? We'd love to hear it! Here's how you can submit a feature request:

  1. Check the existing issues to make sure your idea hasn't already been suggested.
  2. If your idea hasn't been suggested, create a new issue and label it as a "feature request".
  3. Give your feature request a descriptive title and provide a detailed description of what you'd like to see added or improved in Team Production System.
  4. If possible, include any relevant screenshots, mockups, or examples that can help illustrate your idea.
  5. Be sure to tag the issue with the appropriate labels to help us organize and prioritize feature requests.
  6. Our team will review the feature request and provide feedback, ask questions, or discuss potential solutions.
  7. Once the feature request is approved, we'll work on implementing it as soon as possible.

We're always looking for ways to improve Team Production System, and your ideas can help make it even better. Thank you for your contribution!